Рубрики
Uncategorized

WSO2 API Cloud — Добавление последовательностей посредничества, документов и миниатюр API с использованием инструмента CLI.

WSO2 API Cloud предлагает готовое решение для создания, публикации и управления всеми APPEC … Tagged с WSO2, Cloud, DevOps, новичками.

WSO2 API Cloud предлагает готовое решение для создания, публикации и управления всеми аспектами API и его жизненного цикла. Чтобы зарегистрироваться и начать с WSO2 API Cloud, перейдите к http://wso2.com/cloud/api-cloud/

В моей предыдущей статье я сосредоточился на разработке, инициализации и развертывании API в облако API WSO2 из командной строки используя Apimcli Tool Анкет

👉 Предыдущая статья

  • Инициализация и развертывание облачных проектов WSO2 API с использованием инструмента CLI

В этой статье мы сосредоточены на добавлении последовательностей посредничества, документов и миниатюр API из командной строки с использованием инструмента ApimCli, для API в облаке API WSO2.

Вы можете следить за тем же подходом конфигурации среды разработки, который я объяснил в моей предыдущей статье.

Как только проект API инициализирован и заменил файл API.yaml и файл Swagger.json с помощью наших фактических файлов [Ex api.yaml , Swagger.json ], Я развернул API, используя инструмент CLI для облачной платформы API WSO2, как ниже:

Подход к развертыванию был четко объяснен в предыдущей статье

Добавление последовательностей посредничества из CLI.

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

Если вам нужно изменить или преобразовать запросы и ответы вашего API, вам необходимо задействовать посредничество сообщений, которое перехватывает поток по умолчанию. Шлюз API имеет поток посредничества по умолчанию, который вы можете расширить, используя политику посредничества. Вы можете создать пользовательскую посредническую политику вручную или использовать инструмент, а затем привлечь ее к API. Это позволит вам изменить поток посредничества по умолчанию для различных вариантов использования в соответствии с вашим требованием.

  • Узнайте больше О политике посредничества в посредничестве API WSO2.

  • Здесь Вы можете узнать, как добавить политики последовательности посредничества из облака API WSO2 Веб -интерфейс

Посмотрим, как мы можем сделать это с помощью CLI

1. Прежде всего, вам нужно подготовить свой в потоке , Out-Flow и разломный переход Обычай Файлы политики посредничества (.xml)

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

Скачать Последовательность , вне последовательности , Последовательность разлома

3. Вам нужно создать папку с именем «Custom» , внутри каждого каталога последовательности в структуре папки проекта API, и вы должны сохранить соответствующие .Xml файлы внутри соответствующих Обычай папки.

Как ниже:

Shappestore │ A api_params.yaml │ ├acks Документы │ ├ack -изображение │ ├ack Meta-Information │ ———- ├ack Api.yaml │ ———- └ack Swagger.yaml │ └ackees │ ——— │ ——————— └ˆ000 Пользователь │ ———————————- └í½ in-seq.xml │ ——— │ ——————— └ˆ000 Пользователь │ ———————————- └í½ Out-seq.xml │ ———- └acke-последовательность │ ——————— └ˆ000 Пользователь │ ———————————- └í½ Fault-seq.xml

4. Затем вам нужно включить пользовательские последовательности посредничества в определении API api.yaml Файл также.

Просто добавьте эти ключи в api.yaml :

# Mediation Sequence
inSequence: in_seq
outSequence: out_seq
faultSequence: fault_seq
Обратите внимание, что вы можете добавить и сохранить несколько файлов последовательности в пользовательской папке, и вы можете включить, какой из них рассматриваться с этими клавишами в api.yaml

5. Наконец вам нужно Войдите в целевого арендатора из CLI Как я объяснил в Предыдущая статья и Импортируйте API в целевой арендатор API API WSO2

#apimcli login  -u  -p  
apimcli login wso2apicloud -u mihindu@wso2.com@development -p PASS54687 -k

Также вы можете войти так:

#apimcli login  
apimcli login wso2apicloud
Username: mihindu@wso2.com@development
Password:

Logged into wso2apicloud environment

После входа в целевого арендатора вы можете импортировать API, используя следующую команду.

apimcli import-api -f ./path/SampleStore -e wso2apicloud --preserve-provider=false --update --verbose -k
Вернитесь на веб -платформу API API WSO2, и вы можете подтвердить, что ваши изменения были успешно обновлены в веб -интерфейсе.

Добавление документов API из CLI.

WSO2 API Cloud позволяет загружать документации в ваши проекты API из веб -пользовательского интерфейса.

Давайте посмотрим, как мы можем добавить документы в проекты Cloud API с использованием инструмента CLI.

1. Вам нужно подготовить документы, которые вы хотите загрузить в свой проект API.

2. Держите свои документы в следующем каталоге.

Spamplestore> Docs> FileContents> …

Samplestore │ ─жем API_PARAMS.YAML │ ├CY ─ Документы │ ———- ├ack. FileContents │ ——————— └бя ─ doc1.md │ ———- └acks ocs.json │ ├acin │ ———- └ack Swagger.yaml │ └acstere. Outse-Sevessence │ ———- └acke Последовательность.

3. Тогда вам нужно создать и поддерживать docs.json Файл в Настройте документы С облаком API вы добавили в приведенный выше каталог.

Shappestore> Docs> Docs.json

Здесь вы можете поддерживать отдельный объект для каждого добавленного вами документа и настроить Идентификатор, имя, резюме, SourceType, Visibility, Lastupdate, FilePath

[
  {
    "id": "61d20220-9b81-427f-a189-db933b06a070",
    "type": "HOWTO",
    "name": "ReadMe",
    "summary": "ReadMe",
    "sourceType": "FILE",
    "visibility": "API_LEVEL",
    "lastUpdated": "Jan 13, 2021 9:45:43 PM",
    "filePath": "README.md"
  }
]

5. Тогда вам нужно включить этот ключ, как ниже в api.yaml Определение API также.

# Enabling Documents Adding
documents: []

5. Наконец, вам нужно Войдите в целевого арендатора из CLI Как я объяснил выше, и Импортируйте API в целевой арендатор API API WSO2

apimcli import-api -f ./path/SampleStore -e wso2apicloud --preserve-provider=false --update --verbose -k
Вернитесь на веб -платформу API API WSO2, и вы можете подтвердить, что ваши документы успешно обновлялись в веб -интерфейсе.

Добавление миниатюр проекта API из CLI.

Вы можете загрузить миниатюры Project API с пользовательского интерфейса WSO2 API Cloud Web Web.

Здесь я покажу вам, как вы можете добавить миниатюру с помощью инструмента CLI.

1. Существует несколько стандартных рекомендаций WSO2, которые вы должны следовать при настройке миниатюрного изображения. (Скачать образец icon.jpeg )

  • Миниатюрный изображение должно быть в размере 100px x 100px
  • Миниатюрный изображение должно быть переименовано в «ïcon.jpeg»

2. Затем вам нужно разместить изображение в следующем каталоге.

Shappestore │ ├ack -изображение │ ———- └í000 icon.jpeg

3. Наконец, вам нужно Войдите в целевого арендатора из CLI Как я объяснил выше, и Импортируйте API в целевой арендатор API API WSO2

apimcli import-api -f ./path/SampleStore -e wso2apicloud --preserve-provider=false --update --verbose -k
Вернитесь на веб -платформу API API WSO2, и вы можете подтвердить, что ваши изменения в миниатюре были успешно обновлены в веб -интерфейсе.

👉 Что дальше?

  • Тестирование облачных API API WSO2 с использованием инструмента CLI

Благодарю вас

Надеюсь, вам все понравились и что -то узнали из этого. Дайте мне знать ваши комментарии и предложения в разделе обсуждения.

👉 Посетите меня — https://mihinduranasinghe.com/

Оригинал: «https://dev.to/mihinduranasinghe/wso2-api-cloud-adding-mediation-sequences-documents-and-api-thumbnails-from-cli-tool-3l5h»

Читайте ещё по теме: