NOTEYou can use the
ssd api-management create apicommand or its shortened versionssd apim create api.
TIPFor more specific information, refer to the documentation on creating APIs on Sensedia API Platform.
The ssd api-management create api command can be followed by flags with their respective arguments:
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:
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 |
|---|---|---|
| -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 |
NOTEIt is possible to create a Rest API using a
.yamlfile with the declarative mode. Learn more.
We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more