> For the complete documentation index, see [llms.txt](https://docs.pynt.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pynt.io/documentation/applications-view/manage-sources-for-api-discovery/source-categories/api-documentation/swagger.md).
# Swagger
[Swagger](https://swagger.io/tools/open-source/) from SmartBear Software is an open-source framework that provides a comprehensive set of rules, specifications, and tools for developing, documenting, and describing RESTful APIs. It has become one of the most widely adopted standards for API documentation due to its ability to create interactive, machine-readable, and human-readable API definitions. Swagger simplifies the process of designing APIs by providing a standard way to describe endpoints, operations, parameters, request/response models, and authentication methods.
The Swagger framework includes a variety of tools that enhance API development and documentation, such as **Swagger Editor** for writing and editing OpenAPI Specifications, **Swagger UI** for creating interactive documentation, and **Swagger Codegen** for generating client libraries, server stubs, and API documentation in multiple programming languages. These tools make it easier for developers to create, visualize, and share API documentation that is both accurate and accessible.
Swagger’s compatibility with the OpenAPI Specification (OAS) means that it can be used to document APIs in a way that is both standardized and widely recognized across the industry. This not only facilitates better communication between API developers and consumers but also ensures that APIs are easy to integrate and maintain.
As part of its [API Catalog](/documentation/api-catalog/api-catalog-overview.md) Pynt allows seamless [integration](/documentation/applications-view/manage-sources-for-api-discovery.md) with Swagger for API documentation.\
\
By integrating Pynt with Swagger, you can enhance the discovery and security of your APIs. Pynt automatically discovers APIs defined in your Swagger documentation, providing real-time risk assessments and insights.
Swagger
---
# 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.pynt.io/documentation/applications-view/manage-sources-for-api-discovery/source-categories/api-documentation/swagger.md?ask=&goal=
```
`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.