cosmos-sdk/docs/light/update_API_docs.md

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.json.
   2. Edit API docs within SwaggerHub. Please refer to this document 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