API Creation (ssd api-management create api)

The ssd api-management create api command allows you to create an API on Sensedia API Platform.

You can use the ssd api-management create api command or its shortened version ssd apim create api.

For more specific information, refer to the documentation on creating APIs on Sensedia API Platform.

Usage

The ssd api-management create api command can be followed by flags with their respective arguments:

ssd api-management create api [flags]

If no flag is specified, the interactive mode will be activated.

You can create the API by importing a Swagger or setting it by flags, as in the following examples:

# Creates a new API
$ ssd api-management create api "Open Banking" --path "/ob/v1"

# Creates a new API with a specific stage
$ ssd api-management create api "Open Banking" --path "/ob/v1" --stage "AVAILABLE"

# Creates a new API with a specific version
$ ssd api-management create api "Open Banking" --path "/ob/v2" --version "2.0"

# Creates a new API with a specific visibility type
$ ssd api-management create api "Open Banking" --visibility-type "ME"

# Creates a new API through a Swagger in YAML format
$ ssd api-management create api "Open Banking" -f /home/User/Documents/swagger.yaml

# Creates a new API through a Swagger in JSON format
$ ssd api-management create api "Open Banking" -f /home/User/Documents/swagger.json

Available flags

The following flags can be used with the ssd api-management create api command:

Flag	Type	Description
--api-type	string	Type of API to be created (default: "REST")
-d, --description	string	API description
-f, --from-swagger	string	Creates the API through a Swagger file in YAML or JSON format
-h, --help		Displays help for the command
-p, --path	string	Base path of the API to be created
--responsible-team		Team responsible for the API
--responsible-user		User responsible (login) for the API
-s, --stage	string	Workflow stage of the API to be created
-t, --team	string	Name of the team for which the API will be created. Required if the API visibility type is informed as "TEAM".
-v, --version	string	Version of the API to be created (default: "1")
--visibility-type	string	Visibility type of the API to be created (default: "ORGANIZATION")

Flag

Type

Description

--api-type

string

Type of API to be created (default: "REST")

-d, --description

string

API description

-f, --from-swagger

string

Creates the API through a Swagger file in YAML or JSON format

-h, --help

Displays help for the command

-p, --path

string

Base path of the API to be created

--responsible-team

Team responsible for the API

--responsible-user

User responsible (login) for the API

-s, --stage

string

Workflow stage of the API to be created

-t, --team

string

Name of the team for which the API will be created. Required if the API visibility type is informed as "TEAM".

-v, --version

string

Version of the API to be created (default: "1")

--visibility-type

string

Visibility type of the API to be created (default: "ORGANIZATION")

Global Flags

Flag Type Description

Flag	Type	Description
-c, --config	string	Configuration file (default: `$HOME/.sensedia/config.json`)
--profile	string	The configuration profile you want to use (default: "default")
--verbose		Lists all requests made by the command. It is possible to store this information in a TXT file instead of displaying it on the terminal. E.g.: `$ ssd (api-management \| apim) list apis --verbose 2> log.txt`

-c, --config

string

Configuration file (default: $HOME/.sensedia/config.json)

--profile

string

The configuration profile you want to use (default: "default")

--verbose

Lists all requests made by the command. It is possible to store this information in a TXT file instead of displaying it on the terminal. E.g.: $ ssd (api-management | apim) list apis --verbose 2> log.txt

Declarative Mode

It is possible to create a Rest API using a .yaml file with the declarative mode. Learn more.

Thanks for your feedback!

EDIT

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