Criando um arquivo de definição de API REST

É possível usar um assistente para gerar um arquivo swagger.json de amostra para especificar uma interface de programação de aplicativos (API) Representational State Transfer (REST). O assistente está ativado para projetos destinados a um servidor Liberty e que usam o Web 2.5 e superiores.

Sobre Esta Tarefa

Importante: Aplicável ao Liberty, Liberty Core

Procedimento

  1. Crie um projeto da web destinado a um servidor Liberty.

    Para obter mais informações sobre como criar projetos da web, consulte Criando projetos da web.

  2. Crie um arquivo de definição de API REST de swagger concluindo uma das seguintes opções:
    • Selecione Arquivo > Novo > Outros e, em seguida, selecione Arquivo de definição de API REST de swagger na seção Definição de API REST.
    • Clique com o botão direito em um projeto e selecione Novo > Arquivo de definição de API REST de swagger.
  3. Selecione o tipo de JavaScript Object Notation (JSON) a ser criado:
    • Para criar um arquivo com todos os elementos do swagger de nível superior que são necessários, selecione Criar um arquivo de modelo swagger.jsos.
    • Para criar um arquivo com conteúdo de amostra para definições comuns, como GET, PUT e POST, selecione Criar um arquivo de amostra swagger.json.
  4. Selecione um local para o arquivo que está sendo criado:
    • Para trabalhar com anotações do swagger, selecione Gerar como documento de stub (diretório META-INF/stub).
    • Se não estiver trabalhando com anotações do swagger, selecione Gerar como documento de nível superior (diretório META-INF).
      Nota: Essa opção é selecionada por padrão.
  5. Clique em Concluir.

Resultados

As ferramentas geram um arquivo swagger.json na pasta WebContent/META-INF do projeto da web. O arquivo é aberto no editor JSON padrão.

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

File name: t_restapi_create.html