certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Correct inaccurate description

This commit is contained in:
HaoyangLiu 2018-09-27 20:02:31 +08:00
parent bf24a42a29
commit 6d43f9cb0b
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/light/update_API_docs.md
View File

@ -1,18 +1,18 @@
# 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.
Due to the rest handlers and related data structures are complicated and 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
1. Install the swagger-ui generate tool first.
```
make update_dev_tools
make get_tools
```
2. Edit API docs
1. Directly Edit API docs manually: `client/lcd/swaggerui/swagger.json`
2. Edit API docs within this [SwaggerHub](https://app.swaggerhub.com). Please refer to this [document](https://app.swaggerhub.com/help/index) for how to use the about website to edit API docs.
3. Download `swagger.json` and replace the old `swagger.json` under `client/lcd/swaggerui` folds
4. Compile new gaiacli
1. Directly Edit API docs manually: `client/lcd/swagger-ui/swagger.json`.
2. Edit API docs within [SwaggerHub](https://app.swaggerhub.com). Please refer to this [document](https://app.swaggerhub.com/help/index) for how to use the about website to edit API docs.
3. Download `swagger.json` and replace the old `swagger.json` under fold `client/lcd/swagger-ui`.
4. Compile gaiacli
```
make install
```