Gerar uma Especificação de API Wrapper e uma Coleção de Postman

Você pode usar o Blockchain App Builder para criar arquivos de especificação de ponto final de token e conta/identidade filtrados e uma coleção Postman correspondente.

Confirme se o arquivo package.json inclui hardhat-plugin-obp-besu-wrapper-api e se a configuração de Hardhat o importa. Selecione um pacote de tokens gerado com um manifesto e artefatos de token/conta compilados. A ferramenta descobre pacotes compostos a partir de seu manifesto gerado e também oferece suporte a manifestos de projeto de referência importados compatíveis. Ele não implanta nem inicia um serviço de API wrapper. O serviço de API wrapper já está sendo executado como parte da configuração da instância.

1. Gerar especificações de token e conta.
   1. Abra Ferramentas de Desenvolvedor e selecione Gerar Especificação da API do Wrapper e Coleção de Postman.
   2. Em Configuração, selecione o projeto Hardhat, o pacote de tokens e uma pasta de saída dentro do projeto.
   3. Em Mapeamento, revise as APIs de token e as APIs de conta/identidade. Mantenha a opção Gerar APIs do Wrapper selecionada para cada método que permanecerá na especificação do ponto final. Edite o caminho do ponto final quando necessário.
   4. Selecione Gerar para gravar os arquivos JSON de especificação de conta e token filtrados e a coleção Postman.
2. Adicione pontos finais ORDS Swagger/OpenAPI.
   1. Na exibição Mapeamento, a API ORDS selecionada. A ferramenta suporta apenas entrada ORDS API.
   2. Selecione um arquivo JSON ORDS Swagger/OpenAPI.
   3. Gere os ativos do wrapper novamente.
3. Crie uma API combinada, que define um workflow sequencial que combina métodos de token ou conta selecionados em um ponto final de API wrapper.
   1. Em Mapeamento, selecione Usar na API Combinada para cada método elegível.
   2. Selecione Criar API Combinada.
   3. Informe o nome da API e o caminho do ponto final combinados.
   4. Revise e reordene as etapas selecionadas. Para cada etapa, mapeie seus campos de origem request-payload.
   5. Salve o rascunho da API combinada e selecione Gerar.
4. Registre especificações com um serviço de API wrapper.
   1. Certifique-se de que um serviço de API do wrapper esteja em execução e selecione a guia Implantar.
   2. Selecione uma especificação de token gerada, uma especificação de conta, ambas as especificações ou forneça um corpo JSON personalizado.
   3. Informe o URL do host da API do wrapper.
   4. Selecione um ambiente Besu do Oracle Blockchain Platform para que a solicitação possa reutilizar suas definições de autenticação e TLS.
   5. Revise a visualização do registro e registre as especificações selecionadas.

O registro é publicado no ponto final /register do serviço de API wrapper. A ferramenta pode usar o caminho da CA privada de um ambiente do Oracle Blockchain Platform selecionado ou a definição autoassinada explícita para a solicitação de registro; ela não implanta o serviço em si.

Solucionando Problemas

Condição	Resolução
Artefatos ou manifesto ausentes	Compile o projeto selecionado e confirme se os arquivos de pacote gerados/importados existem.
Nenhum ponto final é gerado	Selecione pelo menos um método para geração de API wrapper ou salve pelo menos uma API combinada válida.
Falha na geração do ORDS	Forneça um arquivo JSON ORDS Swagger/OpenAPI e confirme se o plug-in de projeto suporta a opção --ords-swagger. Inspecione o log completo do plug-in para verificar erros de esquema ou operação.
A API Combinada foi rejeitada	Verifique o nome/caminho da API, as etapas ordenadas e os mapeamentos do campo de solicitação e salve o rascunho novamente.
Registro indisponível	Gere primeiro os arquivos de especificação do ponto final e, em seguida, selecione um ambiente Besu do Oracle Blockchain Platform e forneça um URL de host da API wrapper acessível.