Criação de API (ssd api-management create api)

O comando ssd api-management create api permite criar uma API na Sensedia API Platform.

É possível utilizar o comando ssd api-management create api ou a sua versão abreviada ssd apim create api.

Para obter informações mais específicas, consulte a documentação sobre a criação de APIs na Sensedia API Platform.

Uso

O comando ssd api-management create api pode ser seguido de flags com seus respectivos argumentos:

ssd api-management create api [flags]

Caso nenhuma flag seja especificada, o modo interativo será ativado.

É possível criar a API importando um Swagger ou configurando-a por flags, como nos exemplos a seguir:

# Cria uma nova API
$ ssd api-management create api "Open Banking" --path "/ob/v1"

# Cria uma nova API com um estágio específico
$ ssd api-management create api "Open Banking" --path "/ob/v1" --stage "AVAILABLE"

# Cria uma nova API com uma versão específica
$ ssd api-management create api "Open Banking" --path "/ob/v2" --version "2.0"

# Cria uma nova API com um tipo de visibilidade específico
$ ssd api-management create api "Open Banking" --visibility-type "ME"

# Cria uma nova API por meio de um Swagger em formato YAML
$ ssd api-management create api "Open Banking" -f /home/User/Documents/swagger.yaml

# Cria uma nova API por meio de um Swagger em formato JSON
$ ssd api-management create api "Open Banking" -f /home/User/Documents/swagger.json

Flags disponíveis

As flags que podem ser usadas com o comando ssd api-management create api são as seguintes:

Flag	Tipo	Descrição
--api-type	string	Tipo de API a ser criada (predefinido: "REST")
-d, --description	string	Descrição da API
-f, --from-swagger	string	Cria a API por meio de um arquivo Swagger em formato YAML ou JSON
-h, --help		Exibe a ajuda para o comando
-p, --path	string	Caminho base da API a ser criada
--responsible-team		Time responsável pela API
--responsible-user		Usuário (login) responsável pela API
-s, --stage	string	Estágio de workflow da API a ser criada
-t, --team	string	Nome do time para o qual a API será criada. Obrigatória caso o tipo de visibilidade da API seja informado como "TEAM".
-v, --version	string	Versão da API a ser criada (predefinido: "1")
--visibility-type	string	Tipo de visibilidade da API a ser criada (predefinido: "ORGANIZATION")

Flag

Tipo

Descrição

--api-type

string

Tipo de API a ser criada (predefinido: "REST")

-d, --description

string

Descrição da API

-f, --from-swagger

string

Cria a API por meio de um arquivo Swagger em formato YAML ou JSON

-h, --help

Exibe a ajuda para o comando

-p, --path

string

Caminho base da API a ser criada

--responsible-team

Time responsável pela API

--responsible-user

Usuário (login) responsável pela API

-s, --stage

string

Estágio de workflow da API a ser criada

-t, --team

string

Nome do time para o qual a API será criada. Obrigatória caso o tipo de visibilidade da API seja informado como "TEAM".

-v, --version

string

Versão da API a ser criada (predefinido: "1")

--visibility-type

string

Tipo de visibilidade da API a ser criada (predefinido: "ORGANIZATION")

Flags globais

Flag

Tipo

Descrição

-c, --config

string

Arquivo de configuração (predefinido: $HOME/.sensedia/config.json)

--profile

string

Perfil de configuração que deseja utilizar (predefinido: "default")

--verbose

Lista todas as requisições feitas pelo comando. É possível armazenar essas informações em um arquivo TXT em vez de exibi-las no terminal. Ex.: $ ssd (api-management | apim) list apis --verbose 2> log.txt

Modo declarativo

É possível criar uma Rest API utilizando um arquivo .yaml no modo declarativo. Saiba mais.

Thanks for your feedback!

EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]