Criação de API OData no Builder
1. Selecionar o Package
No Builder, selecione o Package desejado. Esse package será o agrupador da sua API,
armazenando os metadados e os objetos gerados no backend (SAP).
Caso o objeto não seja local, lembre-se de indicar o pacote de transporte (request) e o
package corretamente.
2. Criar uma Nova API OData
-
1. Clique em Criar Novo → API ODATA.
-
2. Informe:
-
Nome da API (seguindo o padrão interno do projeto)
-
Descrição (opcional, mas recomendada)
-
Pacote e Request (se aplicável)
-
Após salvar, o Builder criará automaticamente os objetos correspondentes no SAP (classes e includes).
3. Definir a Fonte de Dados
Selecione a fonte de dados que servirá de base para sua API. Essa fonte pode ser:
-
Uma CDS View,
-
Uma Tabela SAP
-
Ou uma View Customizada criada no próprio Builder.
Depois de escolher a fonte, marque os campos que serão expostos pela API (por exemplo, MANDT, LIFNR, BUKRS, BELNR, etc).
4. Configurar os Métodos
Na aba de configuração da API, atribua os includes correspondentes aos métodos padrão do OData:
| Método | Include Padrão | Descrição |
|---|---|---|
| GET | ZMM_Pxxx_OICGET | Recupera registros da fonte de dados |
| POST | ZMM_Pxxx_OICPOST | Cria novos registros |
| PUT | ZMM_Pxxx_OICPUT | Atualiza registros existentes |
| DELETE | ZMM_Pxxx_OICDELETE | Exclui registros existentes |
Dica: mantenha a consistência de nomenclatura conforme o padrão do projeto (ex: ZMM_P003). Após salvar, o Builder gerará automaticamente a classe principal da API com os includes referenciados.
5. Visualizar a Classe no SAP
Com a API criada, acesse o SAP Logon e abra a transação SE24. No campo de pesquisa, informe o nome da classe gerada pelo Builder (exemplo: ZCL_API_P003_VENDAS).
Você poderá visualizar e inspecionar:
-
Os métodos GET/POST/PUT/DELETE
-
As estruturas de entrada e saída
-
O código gerado nos includes
6. Boas Práticas
-
Utilize nomes técnicos padronizados (ZMM_Pxxx_APIxxx).
-
Mantenha o Clean Core: evite customizações diretas fora dos includes.
-
Sempre valide o comportamento no Gateway e no Postman.
-
Versione as APIs criadas conforme evolução funcional.