Skip to content

Commit 3c36204

Browse files
committed
Add openapi.json route documentation (strapi#2143) (strapi#2159)
1 parent 80dc729 commit 3c36204

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docusaurus/docs/cms/plugins/documentation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ The Documentation plugin is not actively maintained and may not work with Strapi
4242

4343
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 <ExternalLink to="https://swagger.io/specification/" text="OpenAPI specification"/>. The Documentation plugin generates the <ExternalLink to="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#paths-object" text="paths objects"/> and <ExternalLink to="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object" text="schema objects"/> and converts all Strapi types to <ExternalLink to="https://swagger.io/docs/specification/data-models/data-types/" text="OpenAPI data types"/>.
4444

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

4749
## Installation
4850

0 commit comments

Comments
 (0)