Gerar automaticamente definições de solicitação de API

Use solicitações de amostra feitas para um recurso de API para gerar associações de cabeçalho de solicitação, associações de parâmetro de consulta e um esquema de solicitação para esse recurso.

Antes de Iniciar

Um administrador de instância deve definir a propriedade do sistema glide.rest.sampling.enabledpara verdadeiro. Para limitar a probabilidade de problemas de desempenho, habilite a geração automática de definições de solicitação de API somente em instâncias de não produção.

Função necessária: web_service_admin

Procedimento

1. Crie uma configuração de amostra de solicitação da REST API com script de uma das seguintes maneiras.

   Opção	Procedimento
   Navegue por um registro da REST API com script	Navegar até Tudo > Serviços web do sistema > Serviços REST com script > Scripted REST APIs. Selecione um registro da REST API com script. Em Recursos lista relacionada, selecione um recurso. Em Configuração de amostragem de solicitação selecione Novo .
   Navegue diretamente para uma nova configuração de amostra de solicitação da REST API com script	Navegar até Tudo > Serviços web do sistema > Serviços da Web com script > Configurações de amostragem REST com script. Selecione Novo. Em Recurso REST , selecione ou insira o recurso REST com script para gerar automaticamente definições de solicitação.

2. Em Máximo de amostras insira o número de solicitações de amostra a serem analisadas para geração de definição automática.
   Você deve inserir um número de 1 a 1000.
3. Selecione Enviar.

   As solicitações feitas ao recurso são amostradas para análise, até o número de amostras definidas na etapa 5. Após o número máximo de amostras ser atingido, o estado de configuração de solicitação de amostragem será definido como analisado E esquemas de preparação de solicitação REST estão disponíveis para revisão.

   Você pode selecionar Amostragem concluída do registro de configuração de solicitação de amostragem para encerrar a amostragem antes que o número máximo de amostras seja atingido.

4. Após o término da amostragem, retorne à configuração de solicitação de amostragem que você criou selecionando seu número em Configuração de amostragem de solicitação Do recurso REST com script.
5. Selecione um registro no Esquemas de preparação da solicitação REST lista para revisar e editar as definições de solicitação geradas automaticamente no Cabeçalhos , Corpo e. Parâmetros de consulta campos.
   Corpo a estrutura só é gerada para PUTe. POSTMétodos HTTP.
6. Selecione Confirmar Para adicionar as definições ao recurso da REST API com script e ao serviço da REST API com script associado.

Resultado

• O esquema de preparação da solicitação REST confirmada e as solicitações de amostras são excluídos.
• Cabeçalhos o conteúdo do campo é usado para criar as associações de cabeçalho de solicitação do recurso. Os cabeçalhos de solicitação associados são adicionados aos serviços REST relevantes Cabeçalhos de solicitação .
• Corpo o conteúdo do campo é usado para criar o esquema de solicitação do recurso. O esquema de solicitação do recurso é adicionado aos serviços REST relevantes Esquemas .
• Parâmetros de consulta o conteúdo do campo é usado para criar as associações de parâmetro de consulta do recurso. Os parâmetros de consulta associados são adicionados aos serviços REST relevantes Parâmetros de consulta .
• Todas as definições de solicitação confirmadas que você adicionou estão incluídas na especificação OpenAPI exportável no Explorador da API REST. Para obter mais informações sobre como exportar especificações OpenAPI, consulte Exporte para especificação OpenAPI.