Skip to content

Commit

Permalink
labor limae
Browse files Browse the repository at this point in the history
  • Loading branch information
luca.gobbi committed Dec 10, 2024
1 parent 07b9810 commit e31d39d
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion mkdocs/production/network/custom-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ curl http://localhost:1865/custom/hello
!!! note FastAPI under the hood
Since there's FastAPI under the hood, you can use every FastAPI operation parameters like `path`, `tags`, `response_model`, etc.

Here's a more complex example:

```python

from cat.mad_hatter.decorators import endpoint
Expand All @@ -47,7 +49,10 @@ def custom_ingestion(document: CustomDocument, stray=Depends(HTTPAuth(AuthResour

```

## Further Examples
Once you activate your plugin the Cheshire Cat will add the custom endpoints to the FastAPI routes and will clear the
`/docs` cache to reflect the new endpoints and their OpenAPI documentation.

## Available Decorators

You have three different decorators available to declare custom endpoints:

Expand Down

0 comments on commit e31d39d

Please sign in to comment.