> For the complete documentation index, see [llms.txt](https://docs.netmap.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.netmap.dev/api/openapi-swagger.md).

# OpenAPI And Swagger

OpenAPI JSON:

```
/api/openapi.json
```

Swagger UI:

```
/api/docs
```

ReDoc is not configured in `backend/app/main.py`.

Use generated OpenAPI as schema reference, and this documentation for workflow and security context.

## What OpenAPI Is Good For

Use OpenAPI to inspect:

* request body schema names;
* response model names;
* path and query parameters;
* validation constraints;
* generated operation IDs;
* available HTTP methods.

## What This Documentation Adds

The generated schema does not fully explain:

* operational workflows;
* security consequences;
* role intent;
* API-key lifecycle;
* reverse proxy requirements;
* backup and restore context;
* known limitations.

Use both sources together.

## Local Check

```bash
curl --fail http://127.0.0.1:8080/api/openapi.json
```

Swagger UI:

```
http://127.0.0.1:8080/api/docs
```

## Related Pages

* [Endpoint Reference](/api/endpoint-reference.md)
* [API Authentication](/api/authentication.md)
* [API Errors](/api/errors.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.netmap.dev/api/openapi-swagger.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.