Register swagger API

[anilcse]

Description

• Move swagger docs from client/grpc-gateway to client/docs
• Fix swagger generation to combine old api docs. Remove x/ibc docs from old swagger
• Register swagger docs API in app.go, this allows other applications to override/customize swagger API easily

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

• Targeted PR against correct branch (see CONTRIBUTING.md)
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• Code follows the module structure standards.
• Wrote unit and integration tests
• Updated relevant documentation (docs/) or specification (x/<module>/spec/)
• Added relevant godoc comments.
• Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
• Re-reviewed Files changed in the Github PR explorer
• Review Codecov Report in the comment section below once CI passes

[codecov]

Codecov Report

Merging #7246 into master will decrease coverage by 0.01%.
The diff coverage is 11.11%.

@@            Coverage Diff             @@
##           master    #7246      +/-   ##
==========================================
- Coverage   55.84%   55.82%   -0.02%     
==========================================
  Files         586      586              
  Lines       35967    35975       +8     
==========================================
  Hits        20084    20084              
- Misses      13914    13922       +8     
  Partials     1969     1969              

[alexanderbez]

utACK

[clevinson]

ACK! One small point about the names of temp folders created.

Also- is it possible to mark certain API endpoints (e.g. all legacy REST endpoints) as deprecated/soon-to-be-deprecated in Swagger docs?

Looking at the swagger UI it's a bit confusing which endpoints are part of legacy and which ones are the new protobuf ones. (yes I understand that anything with /cosmos or /ibc prefixes are proto, but this is not very intuitive for new developers.

[clevinson]

Can we output these to a default root directory other than ./ ?

As it is now, this would cause problems if in the future we add a ./ibc or ./cosmos directory for any purpose besides these swagger auto generated files.

[anilcse]

Also- is it possible to mark certain API endpoints (e.g. all legacy REST endpoints) as deprecated/soon-to-be-deprecated in Swagger docs?

Yes 100%, I'll address this in a followup PR

Can we output these to a default root directory other than ./ ?

As it is now, this would cause problems if in the future we add a ./ibc or ./cosmos directory for any purpose besides these swagger auto generated files.

Correct, but we don't have custom output directory support for protoc-sawgger-gen. I have created an issue upstream to add support for that. For now,

• We can revert this to remove all generated files (find ./ -name 'query.swagger.json' -exec rm {} \;) first and then remove ./cosmos, ./ibc directories if they are empty. wdyt?

[anilcse]

We have a way to override the output directory for swagger generated files. It;s being addressed here: #7374 & #7399

[fedekunze]

looks good! how do I deploy the swagger docs locally?

[anilcse]

looks good! how do I deploy the swagger docs locally?

you can access it via http://localhost:1317/swagger/. By default swagger api is disabled, you can enable them by changing api.enable in app.toml

[fedekunze]

you can access it via http://localhost:1317/swagger/. By default swagger api is disabled, you can enable them by changing api.enable in app.toml

Is that documented somewhere? If not, can we add it as a todo item for the v0.40 docs?