-
|
Is there an "offline" way to view the REST API docs without installing nginx, nginx-agent, go and enabling swagger? I'd like to get a feel for what can and can't be done via the REST API before I decide whether I want to install and use it. |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 1 reply
-
|
Hi @mikey-t, the REST API definitions are defined here in this swagger.json file https://github.com/nginx/agent/blob/main/docs/swagger.json. You can use a swagger editor like this one https://editor-next.swagger.io/ to view it more easily. Just copy the contents of the json file into the editor and it will display a preview of the docs. |
Beta Was this translation helpful? Give feedback.
-
|
That's what I needed, thanks! |
Beta Was this translation helpful? Give feedback.
Hi @mikey-t, the REST API definitions are defined here in this swagger.json file https://github.com/nginx/agent/blob/main/docs/swagger.json. You can use a swagger editor like this one https://editor-next.swagger.io/ to view it more easily. Just copy the contents of the json file into the editor and it will display a preview of the docs.