Импорт и экспорт
Импорт контрактов
Контракты можно импортировать из внешних спецификаций. При импорте система автоматически создаёт контракты на основе описания операций в файле.
Доступные форматы зависят от типа объекта:
Сервис
| Формат | Расширения | Протокол |
|---|---|---|
| OpenAPI | .yaml, .yml, .json | REST |
| Protobuf | .proto | gRPC |
| GraphQL | .graphql, .gql | GraphQL |
| WSDL | .wsdl, .xml | SOAP |
Очередь сообщений
| Формат | Расширения | Протокол |
|---|---|---|
| AsyncAPI | .yaml, .yml, .json | Kafka, AMQP, MQTT |
База данных
| Формат | Расширения | Протокол |
|---|---|---|
| SQL DDL | .sql, .ddl | PostgreSQL, MySQL, MariaDB, MS SQL, Oracle DB, ClickHouse |
| Prisma | .prisma | PostgreSQL, MySQL, MariaDB, MongoDB |
| JSON Schema | .json, .schema.json | MongoDB, DynamoDB, Elasticsearch |
| Avro | .avsc, .avro | Kafka, Cassandra, PostgreSQL |
| DBML | .dbml | PostgreSQL, MySQL, MariaDB, MS SQL |
| Redis Schema | .yaml, .yml, .json | Redis |
| GraphQL | .graphql, .gql | Neo4j |
Рекомендация
Рекомендуется сначала импортировать контракты для объектов, а затем использовать их при создании действий в связях. Это обеспечивает согласованность описания API.
Экспорт системы
Экспорт позволяет сохранить содержимое системы в файл для переноса в другую команду или организацию.
Что включается в экспорт
- Все объекты с их свойствами, положением на доске и размерами
- Контракты объектов
- Связи между объектами с действиями
- Теги и технологии объектов и связей
- Адреса объектов
- Вложенность объектов в группы и рамки
Анонимизация
При экспорте все внутренние идентификаторы заменяются на новые случайные. Это гарантирует, что при импорте не возникнет конфликтов с существующими данными. Текстовое содержимое (названия, описания, тела контрактов) сохраняется без изменений.
Импорт системы
Импорт позволяет загрузить ранее экспортированную систему в существующую систему.
Внимание
При импорте все текущие объекты и связи в целевой системе заменяются содержимым импортируемого файла. Это полная замена, а не слияние.
Обработка тегов и технологий
При импорте теги и технологии сопоставляются по названию:
- Если тег или технология с таким названием уже существует в организации — используется существующий
- Если не существует — создаётся новый
Права доступа
| Действие | Наблюдатель | Редактор | Администратор | Владелец команды | Владелец организации |
|---|---|---|---|---|---|
| Импорт контрактов | ✓ | ✓ | ✓ | ✓ | |
| Экспорт системы | ✓ | ✓ | ✓ | ✓ | |
| Импорт системы | ✓ | ✓ | ✓ | ✓ |