Перейти к содержимому
API Builder

Пространство для проектирования REST API

Сначала API.
Потом код.

Наметьте эндпоинты, свяжите схемы и продумайте структуру. Визуальный редактор для разработчиков: от первой идеи до OpenAPI.

Начать проектирование

Банковская карта не нужна. Экспортируйте дизайн, когда потребуется.

API книжного магазина

Пример дизайна API

OpenAPI 3.0

Ресурс

Books

GET/books
POST/books
GET/books/{id}

Book

Схема
id
string
title
string
author
string

Аутентификация

Bearer JWT

ОтветРесурсы, схемы и аутентификация. Всё связано.
Один дизайн. Два способа работы.Попробуйте сменить режим
На основе привычных стандартовOpenAPI 3.0JSON SchemaPostman

Ясность до кода

Детали должны быть вместе.

Не в разрозненных заметках и файлах. Храните эндпоинты, схемы данных и аутентификацию в одном дизайне API.

01

Видны все связи.

Проследите связь эндпоинта со схемой ответа и требованиями аутентификации. Примите эти решения до написания кода.

GET /booksBook[]
02

Вся картина. Каждая деталь.

Изучайте связи на холсте. Переключайтесь в плоский режим для работы с деталями. Дизайн остаётся тем же.

ХолстСписок
03

Не начинайте с пустоты.

Опишите, что хотите создать. ИИ подготовит основу, а вы проверите и доработаете дизайн.

Ваша идея. Основа для работы.

Сначала продумайте

Продумайте связи. Затем пишите код.

Определите структуру API, пока изменения требуют пересмотра дизайна, а не переписывания кода.

От идеи к дизайну API

Понятный путь к первому экспорту.

Начните с ресурса. Добавьте детали. Перенесите результат в привычные инструменты.

01

Наметьте структуру API.

Создайте ресурсы, например Books или Orders. Добавьте эндпоинты с методами, путями и параметрами запроса.

02

Определите контракт.

Задайте общие схемы запросов и ответов. Подключите схемы аутентификации, чтобы требования каждого эндпоинта были явными.

03

Продолжите в своих инструментах.

Экспортируйте OpenAPI в YAML или JSON либо скачайте коллекцию Postman. Ваш дизайн не привязан к редактору.

books.openapi.yamlOpenAPI 3.0
openapi: 3.0.3
info:
  title: Books API
  version: 1.0.0
paths:
  /books:
    get:
      summary: List books
      responses:
        '200':
          description: A list of books

Фрагмент примера · Экспорт OpenAPI

Полезно знать

Перед началом.

Что умеет API Builder, чего он не делает и как использовать результат.

Что здесь можно спроектировать?

REST API с ресурсами, эндпоинтами, параметрами запроса, общими JSON Schema и схемами аутентификации. Все эти части хранятся в одном дизайне API в вашем рабочем пространстве.

Сервис создаёт или размещает бэкенд?

Нет. API Builder помогает спроектировать контракт API и экспортировать его. Вы пишете и размещаете бэкенд с помощью своих инструментов.

Обязательно работать на холсте?

Нет. Плоский режим позволяет работать со списками на вкладках и панелью деталей. Переключайтесь между ним и холстом без создания отдельного дизайна.

Можно работать без ИИ?

Да. Всё можно создавать и редактировать вручную. ИИ нужен только как дополнительный способ получить основу дизайна из описания. Проверяйте его результат перед использованием.

Какие форматы экспорта доступны?

Документ OpenAPI 3.0 в YAML или JSON либо коллекция Postman. Результат можно скопировать или скачать из редактора.

Нужен ли аккаунт?

Да. Войдите, чтобы создавать и сохранять дизайны API в личном рабочем пространстве. Банковская карта не нужна. Пример выше можно изучить без аккаунта.

Начните со структуры

Здесь начинается ваш следующий API.

Превратите идею в дизайн, по которому можно писать код.

Начать проектирование

Банковская карта не нужна. Экспортируйте дизайн, когда потребуется.