Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sei-protocol/sei-chain
https://github.com/sei-protocol/sei-chain
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sei-protocol/sei-chain
- Owner: sei-protocol
- License: apache-2.0
- Created: 2022-05-17T22:17:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T12:50:23.000Z (3 months ago)
- Last Synced: 2024-10-29T14:39:08.789Z (3 months ago)
- Language: TypeScript
- Size: 282 MB
- Stars: 2,701
- Watchers: 121
- Forks: 808
- Open Issues: 96
-
Metadata Files:
- Readme: docs/README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ccamel - sei-protocol/sei-chain - (Go)
README
# OpenAPI/Swagger docs generation
> **Note:** Anytime we make changes to the APIs/proto files, we also need to update the Swagger/OpenAPI docs.
Both Swagger and OpenAPI terms are used interchangeably in this document.
- [OpenAPI](https://github.com/OAI/OpenAPI-Specification/) = specification
- Swagger = Tools for implementing the specification.
The process of Swagger docs generation involves running a script that does the following tasks:
1. Generating the swagger yml file using the `ignite` tool.
2. Updating the static assets for the Swagger UI.
## Prerequisites
The docs generation script uses the `ignite` tool to generate the OpenAPI docs.
So, first install the `ignite` tool, if not installed already.
We need version v0.23.0, which is outdated, but works with the current version of the codebase.
Pull binaries from the [releases page](https://github.com/ignite/cli/releases/tag/v0.23.0) or install from source code
following instructions.
Verify the installation by running `ignite version`:
```bash
% ignite version
·
· 🛸 Ignite CLI v28.2.0 is available!
·
· To upgrade your Ignite CLI version, see the upgrade doc: https://docs.ignite.com/guide/install.html#upgrading-your-ignite-cli-installation
·
··
Ignite CLI version: v0.23.0
....
```
## Running the script
Then run the following command to generate the OpenAPI docs and update static assets for Swagger UI:
```bash
./scripts/update-swagger-ui-statik.sh
```
The script generates a new swagger/openapi yml and saves it as `docs/swagger-ui/swagger.yml`.
It will then embed the yml file and static assets in `docs/swagger-ui/` directory into the `docs/swagger/statik.go` file.
If swagger endpoint is configured, the app on startup will "read" `statik.go` and make it's content available at the
`/swagger/` endpoint.
# Serving the OpenAPI docs on the node
To start serving the docs, enable the swagger docs serving.
To do that, update `api.swagger` value to `true` in the `app.toml` file.
```toml
###############################################################################
### API Configuration ###
###############################################################################
[api]
# Enable defines if the API server should be enabled.
enable = true
# Swagger defines if swagger documentation should automatically be registered.
swagger = true
```
Once node is restarted, swagger docs will be available at `http://:/swagger/`