Skip to content

Integrate a Web API with swagger documentation #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Integrate a Web API with swagger documentation #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4868bd7
Add FastAPI-based REST interface
javadghane Oct 24, 2025
7ee9164
Merge pull request #1 from javadghane/codex/add-rest-api-integration-…
javadghane Oct 24, 2025
ba6bebe
Add Swagger specification for REST API
javadghane Oct 24, 2025
c576aaf
Merge pull request #2 from javadghane/codex/add-rest-api-integration-…
javadghane Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,18 @@ queue.create_queue("my_queue")
queue.create_partitioned_queue("my_partitioned_queue", partition_interval=10000)
```

### REST API and Swagger documentation

An optional FastAPI-powered REST API is available for teams that want to expose
queue operations over HTTP. Create an application with
`pgmq.api.create_app()`, or mount it within an existing ASGI server, and then
visit the automatically generated Swagger UI at `/docs` or ReDoc at `/redoc`.

The repository also includes a static OpenAPI specification that can be used
with tools such as [Swagger UI](https://swagger.io/tools/swagger-ui/) or
[Insomnia](https://insomnia.rest/). You can find it at
[`docs/swagger.yaml`](docs/swagger.yaml).

### List all queues

```python
Expand Down
Loading
Loading