806 B
806 B
How to update API docs
Due to the rest handlers and related data structures are distributed in many sub-folds, currently there is no tool which can automatically extract all APIs information and generate API docs. So here we have to write APIs' docs manually.
Steps
- Install the swagger-ui generate tool first.
make update_dev_tools
- Edit API docs
- Directly Edit API docs manually:
client/lcd/swaggerui/swagger.json
- Edit API docs within this SwaggerHub. Please refer to this document for how to use the about website to edit API docs.
- Directly Edit API docs manually:
- Download
swagger.json
and replace the oldswagger.json
underclient/lcd/swaggerui
folds - Compile new gaiacli
make install