focalboard/server/swagger/README.md

19 lines
607 B
Markdown
Raw Normal View History

2021-02-17 20:29:20 +01:00
# Swagger / OpenAPI 2.0 auto-generated files
This folder is generated by the `make swagger` command from comments in the server code.
Prerequisites:
1. [go-swagger](https://goswagger.io/install.html)
2. [openapi-generator](https://github.com/OpenAPITools/openapi-generator)
These can be installed via Homebrew:
```
brew tap go-swagger/go-swagger
brew install go-swagger
brew install openapi-generator
```
2021-02-17 20:32:03 +01:00
# Server API documentation
See the generated [server API documentation here](https://htmlpreview.github.io/?https://github.com/mattermost/focalboard/blob/main/server/swagger/docs/html/index.html).