LaconicNetwork/cosmos-sdk
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Move update_API_docs.md to docs/DOCS_README.md

Browse Source
This commit is contained in:
HaoyangLiu
2018-10-02 23:52:54 +08:00
parent 9830acc5b9
commit e1bb6fc0d2
2 changed files with 20 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/light/update_API_docs.md
-18
View File
@@ -1,18 +0,0 @@
# How to update API docs
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 get_tools
```
2. Edit API docs
1. Directly Edit API docs manually: `client/lcd/swagger-ui/swagger.yaml`.
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.yaml` and replace the old `swagger.yaml` under fold `client/lcd/swagger-ui`.
4. Compile gaiacli
```
make install
```