Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
VishnuSanal committed Oct 28, 2024
1 parent 5c3b035 commit 23aa078
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs_src/src/pages/documentation/api_reference/openapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Out of the box, the following endpoints are setup for you:
- `/docs` The Swagger UI
- `/openapi.json` The JSON Specification

To use a custom openapi configuration, you can:

- Place the `openapi.json` config file in the root directory.
- Or, pass the file path to the `openapi_json_path` parameter in the `Robyn()` constructor. (the parameter gets priority over the file).

However, if you don't want to generate the OpenAPI docs, you can disable it by passing `--disable-openapi` flag while starting the application.

Expand Down
5 changes: 5 additions & 0 deletions docs_src/src/pages/documentation/example_app/openapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ Out of the box, the following endpoints are setup for you:

However, if you don't want to generate the OpenAPI docs, you can disable it by passing `--disable-openapi` flag while starting the application.

To use a custom openapi configuration, you can:

- Place the `openapi.json` config file in the root directory.
- Or, pass the file path to the `openapi_json_path` parameter in the `Robyn()` constructor. (the parameter gets priority over the file).

```bash
python app.py --disable-openapi
```
Expand Down

0 comments on commit 23aa078

Please sign in to comment.