Creación de un archivo de definición de la API REST

Puede utilizar un asistente para generar un archivo swagger.json de plantilla para especificar una interfaz de programación de aplicaciones (API) REST (Representational State Transfer). El asistente está habilitado para proyectos que tienen como destino un servidor de Liberty y utilizan Web 2.5 y posteriores.

Acerca de esta tarea

Importante: Aplicable a Liberty, Liberty Core

Procedimiento

  1. Cree un proyecto web que tenga como destino un servidor de Liberty.

    Para obtener más información sobre cómo crear proyectos web, consulte Creación de proyectos web.

  2. Cree un archivo de definición de la API REST Swagger mediante una de las opciones siguientes:
    • Seleccione Archivo > Nuevo > Otro, y seleccione Archivo de definición API REST Swagger en la sección Definición de API REST.
    • Pulse el botón derecho del ratón en un proyecto y seleccione Nuevo > Archivo de definición Swagger de la API REST.
  3. Seleccione el tipo de archivo JSON (JavaScript Object Notation) que desea crear:
    • Para crear un archivo con todos los elementos Swagger de nivel superior que son necesarios, seleccione Crear un archivo swagger.json de plantilla.
    • Para crear un archivo con contenido de ejemplo para definiciones comunes, como GET, PUT y POST, seleccione Crear un archivo swagger.json de ejemplo.
  4. Seleccione una ubicación para el archivo que está creando:
    • Para trabajar con anotaciones de Swagger, seleccione Generar como documento de apéndice (directorio META-INF/stub).
    • Si no trabaja con anotaciones de Swagger, seleccione Generar como documento de nivel superior (directorio META-INF).
      Nota: Esta opción está seleccionada de forma predeterminada.
  5. Pulse Finalizar.

Resultados

Las herramientas generan un archivo swagger.json en la carpeta WebContent/META-INF para su proyecto web. El archivo se abre en el editor de JSON predeterminado.

Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_restapi_create.html