From 0a6cc2bb0fef96e63cc4374ae297e1294c90ca96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20F=C3=A4ssler?= Date: Mon, 29 Jul 2024 21:39:37 +0200 Subject: [PATCH] Add openapi.json route documentation (#2143) --- docusaurus/docs/dev-docs/plugins/documentation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docusaurus/docs/dev-docs/plugins/documentation.md b/docusaurus/docs/dev-docs/plugins/documentation.md index a8ec198c3a..e1e12372f1 100644 --- a/docusaurus/docs/dev-docs/plugins/documentation.md +++ b/docusaurus/docs/dev-docs/plugins/documentation.md @@ -10,7 +10,9 @@ The Documentation plugin is useful to document the available endpoints once you 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/). -The generated documentation can be found in your application at the following path: `src/extensions/documentation/documentation//full_documentation.json` +The generated documentation can be accessed either through your application's source code or through the running application itself: +- **Source code**: The documentation is located at
`src/extensions/documentation/documentation//full_documentation.json` +- **Running application**: Use the URL
`:/documentation//openapi.json` ## Installation