Creación de API (ssd api-management create api)

El comando ssd api-management create api le permite crear una API en Sensedia API Platform.

Es posible utilizar el comando ssd api-management create api o su versión abreviada ssd apim create api.

Para obtener información más específica, consulte la documentación sobre la creación de APIs en Sensedia API Platform.

Uso

El comando ssd api-management create api puede ir seguido de flags con sus respectivos argumentos:

ssd api-management create api [flags]

Si no se especifica ningún flag, se activará el modo interactivo.

Puede crear la API importando un Swagger o configurándola mediante flags, como en los siguientes ejemplos:

# Crea una nueva API
$ ssd api-management create api "Open Banking" --path "/ob/v1"

# Crea una nueva API con una etapa específica
$ ssd api-management create api "Open Banking" --path "/ob/v1" --stage "AVAILABLE"

# Crea una nueva API con una versión específica
$ ssd api-management create api "Open Banking" --path "/ob/v2" --version "2.0"

# Crea una nueva API con un tipo de visibilidad específico
$ ssd api-management create api "Open Banking" --visibility-type "ME"

# Crea una nueva API mediante un Swagger en formato YAML
$ ssd api-management create api "Open Banking" -f /home/User/Documents/swagger.yaml

# Crea una nueva API mediante un Swagger en formato JSON
$ ssd api-management create api "Open Banking" -f /home/User/Documents/swagger.json

Flags disponibles

Los flags que se pueden usar con el comando ssd api-management create api son los siguientes:

Flag	Tipo	Descripción
--api-type	string	Tipo de API que se creará (por defecto: "REST")
-d, --description	string	Descripción de la API
-f, --from-swagger	string	Crea la API mediante un archivo Swagger en formato YAML o JSON
-h, --help		Muestra la ayuda del comando
-p, --path	string	Ruta base de la API que se creará
-s, --stage	string	Etapa de flujo de trabajo de la API que se creará
-t, --team	string	Nombre del equipo para el que se creará la API. Obligatorio si el tipo de visibilidad de la API se informa como "TEAM".
-v, --version	string	Versión de la API que se creará (por defecto: "1")
--visibility-type	string	Tipo de visibilidad de la API que se creará (por defecto: "ORGANIZATION")

Flag

Tipo

Descripción

--api-type

string

Tipo de API que se creará (por defecto: "REST")

-d, --description

string

Descripción de la API

-f, --from-swagger

string

Crea la API mediante un archivo Swagger en formato YAML o JSON

-h, --help

Muestra la ayuda del comando

-p, --path

string

Ruta base de la API que se creará

-s, --stage

string

Etapa de flujo de trabajo de la API que se creará

-t, --team

string

Nombre del equipo para el que se creará la API. Obligatorio si el tipo de visibilidad de la API se informa como "TEAM".

-v, --version

string

Versión de la API que se creará (por defecto: "1")

--visibility-type

string

Tipo de visibilidad de la API que se creará (por defecto: "ORGANIZATION")

Flags globales

Flag

Tipo

Descripción

-c, --config

string

Archivo de configuración (por defecto: $HOME/.sensedia/config.json)

--profile

string

Perfil de configuración que desea utilizar (por defecto: "default")

--verbose

Enumera todas las solicitudes realizadas por el comando. Puede almacenar esta información en un archivo TXT en lugar de mostrarla en el terminal. Ej.: $ ssd (api-management | apim) list apis --verbose 2> log.txt

Modo declarativo

Es posible crear una Rest API utilizando un archivo .yaml con el modo declarativo. Más información.

Thanks for your feedback!

EDIT

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