> For the complete documentation index, see [llms.txt](https://docs.varbase.vardot.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.varbase.vardot.com/10.0.x/content-designers/site-configuration/web-services/openapi.md).

# OpenAPI

OpenAPI in Varbase is used as a means to create, describe, and consume RESTful APIs in a way that is accessible and easily understandable.

### The usage of OpenAPI:

1. **API Documentation:** OpenAPI provides a standardized way to document your API endpoints, making it easier for developers to understand how to interact with your services. 
2. **Auto-generate Code:** With OpenAPI specifications, you can auto-generate client libraries in various programming languages, reducing the time needed to write code for API consumption. 
3. **Interactive API Access:** Tools like Swagger UI use OpenAPI specifications to provide an interactive interface for exploring and testing API endpoints.

This approach streamlines the development process by ensuring that your API is well-documented, maintainable, and easy for other developers to integrate with.

{% hint style="info" %}
**Varbase API**: helps Drupal to connect the OpenAPI Javascript Library for further information visit: [Varbase API](/10.0.x/developers/understanding-varbase/optional-components/varbase-api.md).
{% endhint %}

### How to Navigate OpenAPI in Varbase:

Go to **Configuration/ Web Services/ *****OpenAPI.***

<figure><img src="/files/CYBpfD8rvqIAZEHEFxUV" alt=""><figcaption><p>Navigate OpenAPI</p></figcaption></figure>

<figure><img src="/files/pQe483VCOt5UVebJVXQw" alt=""><figcaption><p>OpenAPI Page</p></figcaption></figure>

### OpenAPI Documentation:

1. Navigate to **Configuration/ Web Services/&#x20;*****OpenAPI.***
2. Click on ***Explore with ReDoc*** or ***Explore with Swagger UI.***
3. You'll be redirected to the OpenAPI Documentation page.

<figure><img src="/files/z1vgGTNztjLQzBA7WHpC" alt=""><figcaption><p>Explore with ReDoc &#x26; Explore with Swagger UI Buttons</p></figcaption></figure>

<figure><img src="/files/kXfaQqlCqQcKMyt58gHu" alt=""><figcaption><p>OpenAPI Documentation - Explore with ReDoc</p></figcaption></figure>

<figure><img src="/files/zQcZ1XiStKipQ30pvegr" alt=""><figcaption><p>OpenAPI Documentation - Explore with Swagger UI</p></figcaption></figure>

{% hint style="info" %}
For further information about OpenAPI Documentation visit: [**Browsing OpenAPI Documentation For JSON API**](/10.0.x/developers/configuring-a-varbase-site/configuring-json-api-features.md#browsing-openapi-documentation-for-json-api)
{% endhint %}


---

# 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://docs.varbase.vardot.com/10.0.x/content-designers/site-configuration/web-services/openapi.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.