From ce86e9d76ac2abe58eb3a214d8d699982fc0cb5b Mon Sep 17 00:00:00 2001 From: Alisina Bahadori Date: Tue, 7 May 2024 13:21:20 -0400 Subject: [PATCH] Add API Documentation link to README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index a370ef4..172cef5 100644 --- a/README.md +++ b/README.md @@ -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