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

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

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

Тестовые запросы к API выполняются не в тестовой среде, а в реально существующих таблицах.

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

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

Как открыть Swagger

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

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

Чтобы делать запросы в Swagger и не только (например, HTTP-запросы), в заголовках нужно указывать данные авторизации.

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

   
2. В “Tokens” нажмите “Create new token”.

   
3. Введите любое название токена и создайте его.

   
4. Скопируйте токен.

   
5. Вернитесь в Swagger и нажмите “Authorize”.

   
6. Вставьте токен и снова нажмите “Authorize”.

   
7. Если в окошке авторизации появилась надпись “Authorized”, значит, вы успешно авторизованы.