Skip to content

Commit

Permalink
Clarify how to access the Documentation plugin UI (strapi#1664)
Browse files Browse the repository at this point in the history
* Rewrite how to access Documentation plugin UI

* Add tip with direct URL link to Documentation plugin UI
  • Loading branch information
pwizla authored Apr 26, 2023
1 parent a3055f3 commit 20e63e3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docusaurus/docs/dev-docs/plugins/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,13 @@ Once the plugin is installed, starting the application generates the API documen

## Swagger UI

The documentation plugin visualizes your API using [Swagger UI](https://swagger.io/tools/swagger-ui/). To access the UI, select "Documentation" in the left sidebar under the "plugins" section. Then click "Open documentation" to open the Swagger UI. Using the Swagger UI you can view all of the endpoints available on your API and trigger API calls.
The Documentation plugin visualizes your API using [Swagger UI](https://swagger.io/tools/swagger-ui/). To access the UI, select *Plugins > ![Documentation plugin icon](/img/assets/icons/documentation-plugin.svg) Documentation* in the main navigation of the admin panel. Then click **Open documentation** to open the Swagger UI. Using the Swagger UI you can view all of the endpoints available on your API and trigger API calls.

:::tip
Once installed, the Documentation plugin UI can be accessed at the following URL:
`<server-url>:<server-port>/documentation/<documentation-version>`
(e.g., [`localhost:1337/documentation/v1.0.0`](http://localhost:1337/documentation/v1.0.0)).
:::

### Authenticated requests

Expand Down
3 changes: 3 additions & 0 deletions docusaurus/static/img/assets/icons/documentation-plugin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 20e63e3

Please sign in to comment.