Skip to content

Commit 0a6cc2b

Browse files
committed
Add openapi.json route documentation (strapi#2143)
1 parent 8c80ed5 commit 0a6cc2b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docusaurus/docs/dev-docs/plugins/documentation.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ The Documentation plugin is useful to document the available endpoints once you
1010

1111
If installed, the Documentation plugin will inspect content types and routes found on all APIs in your project and any plugin specified in the configuration. The plugin will then programmatically generate documentation to match the [OpenAPI specification](https://swagger.io/specification/). The Documentation plugin generates the [paths objects](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#paths-object) and [schema objects](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object) and converts all Strapi types to [OpenAPI data types](https://swagger.io/docs/specification/data-models/data-types/).
1212

13-
The generated documentation can be found in your application at the following path: `src/extensions/documentation/documentation/<version>/full_documentation.json`
13+
The generated documentation can be accessed either through your application's source code or through the running application itself:
14+
- **Source code**: The documentation is located at <br/>`src/extensions/documentation/documentation/<version>/full_documentation.json`
15+
- **Running application**: Use the URL <br/>`<server-url>:<server-port>/documentation/<version>/openapi.json`
1416

1517
## Installation
1618

0 commit comments

Comments
 (0)