Skip to content

Commit

Permalink
Add API Documentation link to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alisinabh authored May 7, 2024
1 parent f9fc229 commit ce86e9d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ You can find the release binaries at `target/release/atlas`. Then you can run at
`./target/release/atlas` in your terminal. Make sure that the `DB_PATH` directory already exists
otherwise atlas crashes on startup.

## API Documentation

Atlas generates OpenApi 3.0 specifications for its APIs. We host our main branch docs at https://atlas-rs.fly.dev/swagger-ui/.

You can also enable the `/swagger-ui` endpoint locally or in your deployments by setting `SWAGGER_UI_ENABLED` to `true`.

## Configuration

Atlas uses OS environment variables for configuration. Here are the list of environment variables
Expand Down

0 comments on commit ce86e9d

Please sign in to comment.