> For the complete documentation index, see [llms.txt](https://docs.ncteam.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ncteam.io/nocodb/swagger/osnovy-i-avtorizaciya.md).

# Основы и авторизация

**Swagger** — это инструмент, который помогает разработчикам создавать, документировать и тестировать API (интерфейсы программирования приложений). Он автоматически генерирует описание для каждого ресурса в REST API, показывая доступные методы, параметры запросов и возвращаемые данные. Это делает документацию понятной как для людей, так и для машин, что упрощает взаимодействие между различными системами. Swagger позволяет разработчикам легко видеть структуру API и тестировать его методы прямо в браузере, что значительно ускоряет процесс разработки.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FksRaISb4s4JTYtiSUooQ%2Fimage.png?alt=media&#x26;token=994de124-2582-4682-a79c-b9b09e43c621" alt=""><figcaption></figcaption></figure>

Основная ценность Swagger заключается в его интерактивности и удобстве. С помощью Swagger UI пользователи могут не только просматривать документацию, но и отправлять тестовые запросы к API, получая мгновенные ответы. Это позволяет быстро проверять работоспособность методов и проводить отладку. Благодаря своей популярности, Swagger стал стандартным инструментом для работы с API и используется разработчиками, тестировщиками и аналитиками для упрощения процессов создания и поддержки программных интерфейсов.

{% hint style="info" %}
Тестовые запросы к API выполняются не в тестовой среде, а в реально существующих таблицах.

Поэтому их также можно воспринимать как ручные манипуляции с данными.

Если в результате теста в ваших таблицах появятся ненужные данные, их также можно удалить или изменить обратно, используя тестовые запросы, либо прямо в интерфейсе NocoDB.
{% endhint %}

## Как открыть Swagger

Чтобы открыть Swagger в NocoDB, нужно в левой панели навести курсор мыши на любую базу, затем нажать на “…” и выбрать “Swagger: REST APIs”.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FyiCAP1znVKCP7XZ2eMYW%2Fimage.png?alt=media&#x26;token=ad4c7845-6329-4d90-aa08-e4c775af6608" alt=""><figcaption></figcaption></figure>

## API Token и авторизация в Swagger

Чтобы делать запросы в Swagger и не только (например, [HTTP-запросы](https://docs.smartbotpro.ru/scenarii/integracii/http-zaprosy)), в заголовках нужно указывать данные авторизации.

1. В NocoDB в левой панели откройте раздел “Team & Settings”.

   <figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FkD0GfH8ZStyJK64alCWs%2Fimage.png?alt=media&#x26;token=23e2c5b3-3aeb-4700-a03c-31e4ce8f3763" alt=""><figcaption></figcaption></figure>
2. В “Tokens” нажмите “Create new token”.

   <figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FybITfgs8a752hDFRKL9g%2Fimage.png?alt=media&#x26;token=a7c892d8-494c-4cc3-aa19-7e03dbf51a2a" alt=""><figcaption></figcaption></figure>
3. Введите любое название токена и создайте его.

   <figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FrCm1JgiIIqv4aEfoaTwY%2Fimage.png?alt=media&#x26;token=db155fce-0d5e-4cee-8cd4-70ee99c85840" alt=""><figcaption></figcaption></figure>
4. Скопируйте токен.

   <figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2F3sV545C8tbZKBUZeGziT%2Fimage.png?alt=media&#x26;token=d28feae9-723f-4fee-8232-7ff0ef8fe361" alt=""><figcaption></figcaption></figure>
5. Вернитесь в Swagger и нажмите “Authorize”.

   <figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FMCzB19FS9R9DhXDtVUUs%2Fimage.png?alt=media&#x26;token=8c50bb6c-d60b-4df8-9fc1-377dbf9ab06a" alt=""><figcaption></figcaption></figure>
6. Вставьте токен и снова нажмите “Authorize”.

   <figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FvtuUmrU6G1DtNr0czqdt%2Fimage.png?alt=media&#x26;token=e0d1dd1b-96d8-4cf8-b226-49b8bb00404d" alt=""><figcaption></figcaption></figure>
7. Если в окошке авторизации появилась надпись “Authorized”, значит, вы успешно авторизованы.

   <figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2F4oe94zQ38acgJNVh1xmf%2Fimage.png?alt=media&#x26;token=e314d962-6f81-46ae-be98-53053bb1070b" alt=""><figcaption></figcaption></figure>
