> For the complete documentation index, see [llms.txt](https://documentation.astera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.astera.com/astera-data-stack-v10/api-flow/api-publishing/manage/server-browser-functionalities-for-api-publishing/swagger-ui-for-api-deployments.md).

# Swagger UI for API Deployments

Astera lets the user view their API deployments in a Swagger UI from the deployment section of the Server Browser.

For our use case, we already have deployments created, as evident in the Server Browser panel:

<figure><img src="https://3083465318-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR50Wa7EwZGlmPSAMkkf%2Fuploads%2FX1DcAAZVeuH7tX8joOFn%2F01-Deployment.PNG?alt=media&amp;token=42bd6cd1-fd33-4688-8a00-b83069a8b620" alt=""><figcaption></figcaption></figure>

1. To view the swagger options, right-click on the deployment node and hover over *Swagger Options*.

<figure><img src="https://3083465318-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR50Wa7EwZGlmPSAMkkf%2Fuploads%2FzGgs64l3zysyHuLSm7Ng%2F02-Options.PNG?alt=media&amp;token=d2d593dd-7cda-4585-9db0-cf4bfa04585a" alt=""><figcaption></figcaption></figure>

2. Selecting *View Swagger UI* is going to present us with a new window where we can see Swagger for our deployed APIs.

The user can authorize, test, copy the response layout, and do a lot more within this UI.

{% hint style="info" %}
**Note:** For deployments made on the local server, users would need to install the machine name certificate of the client to the server directory separately, to be able to test APIs from the Swagger UI.
{% endhint %}

<figure><img src="https://3083465318-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR50Wa7EwZGlmPSAMkkf%2Fuploads%2FLcx8X91yqQsG4vFtCIcb%2F03-UI.PNG?alt=media&amp;token=f7a85c11-8163-4353-ab69-c69782445bb7" alt=""><figcaption></figcaption></figure>

You can expand each endpoint to view its details and you can also provide authorization for when consuming these endpoints.

<figure><img src="https://3083465318-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR50Wa7EwZGlmPSAMkkf%2Fuploads%2FmV29AtDsunaKmEvkqLFJ%2F04-MoreUI.PNG?alt=media&amp;token=f6917a22-2668-4b1c-b216-f6c210e931a8" alt=""><figcaption></figcaption></figure>

This concludes working with the Swagger UI feature in Astera.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.astera.com/astera-data-stack-v10/api-flow/api-publishing/manage/server-browser-functionalities-for-api-publishing/swagger-ui-for-api-deployments.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.