Add api documentation in readme

pull/245/head
Chocobozzz 2018-01-24 12:02:38 +01:00
parent 5e1c08eb94
commit d59a8da813
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
2 changed files with 17 additions and 1 deletions

View File

@ -20,7 +20,16 @@ interested in, user interface, design, decentralized architecture...
## Write documentation ## Write documentation
You can help to write the documentation of the REST API, code, architecture, You can help to write the documentation of the REST API, code, architecture,
demonstrations... demonstrations.
For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory.
Then, you can just open the `openapi.yaml` file in a special editor like [http://editor.swagger.io/](http://editor.swagger.io/) to easily see and edit the documentation.
Some hints:
* Routes are defined in [/server/controllers/](/server/controllers/) directory
* Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory
* Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
## Develop ## Develop

View File

@ -147,6 +147,13 @@ guide](/.github/CONTRIBUTING.md)
to see how to contribute to PeerTube. Spoiler alert: you don't need to be a to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
coder to help! coder to help!
## API REST documentation
For now only on Github:
* HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html)
* Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
## Architecture ## Architecture
See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.