Generación de la API de cliente

Las API de Session Manager se definen en un único archivo YAML. Las API se basan en la especificación OpenAPI3.0, que define una interfaz estándar independiente del idioma para las API RESTful. Para obtener más información, consulteEspecificación de OpenAPI.

Con el archivo YAML, puede generar clientes API en uno de los idiomas compatibles. Para ello, debe utilizar Swagger Codegen 3.0 o posterior. Para obtener más información acerca de los idiomas admitidos, consulterepositorio swagger-codegen.

Para generar el cliente de API

1. Descargue el archivo YAML de la API de Session Manager desde Session Manager Broker. El archivo YAML está disponible en la siguiente URL.

   https://broker_host_ip:port/dcv-session-manager-api.yaml

2. Instala Swagger Codegen.

   • macOS

     $ brew install swagger-codegen

   • En otras plataformas

     $ git clone https://github.com/swagger-api/swagger-codegen --branch 3.0.0

     $ cd swagger-codegen

3. Genere el cliente API.

   • macOS

     $ swagger-codegen generate -i /path_to/yaml_file -l language -o $output_folder

   • En otras plataformas

     $ mvn clean package

     $ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i /path_to/yaml_file -l language -o output_folder