...
Para permitir uma maior autonomia para quem implementa APIs e suas respectivas especificações, são sugeridos dois fluxos para desenvolvimento de integrações via API. Deste modo, o analista pode escolher o fluxo que deseja seguir, de acordo com sua necessidade. Nos tópicos subsequentes serão explicitados as duas formas a partir de seus respectivos fluxogramas e textos explicativos.
...
Neste fluxo de desenvolvimento de integrações, a implementação da API/Adapter vem logo após a definição da especificação do OpenAPI e Schema. Em seguida, o analista adapta a documentação e só então aprova a integração desenvolvida.
Vantagens
- Permite que a API siga para o fluxo de aprovação já com o adapter devidamente alinhado com a especificação OpenAPI, restando apenas o aval do comitê para publicação da integração.
- Analista irá mais bem preparado para discutir a entidade desenvolvida.
Desvantagens
- Possibilidade de retrabalho, já que a implementação virá antes da aprovação da integração pelo comitê.
draw.io Diagram |
---|
border | true |
---|
viewerToolbar | true |
---|
fitWindow | false |
---|
diagramName | API 2 |
---|
simpleViewer | false |
---|
links | blank |
---|
tbstyle | top |
---|
diagramDisplayName | API - Fluxo 1 |
---|
lbox | true |
---|
diagramWidth | 1206 |
---|
revision | 18 |
---|
|
Já o fluxo 2 tem como característica..na segunda sugestão do fluxo de desenvolvimento de integrações, o fluxo de aprovação vem logo depois da definição do OpenAPI e Schema, fazendo com que a implementação da API/Adapter seja realizada só após a aprovação da especificação.
Vantagens
- Mitiga o risco de retrabalho, por ter aprovado a documentação em comitê antes da implementação.
Desvantagens
- As APIs e Mensagens Padronizadas são aprovadas antes da implementação de um POC para garantir a aderência ao negócio.
- Caso durante o desenvolvimento ou testes for identificada a necessidade de outros campos, será necessário solicitar nova versão e aprovação da mesma ao comitê.
draw.io Diagram |
---|
border | true |
---|
viewerToolbar | true |
---|
fitWindow | false |
---|
diagramName | API Fluxo 1 |
---|
simpleViewer | false |
---|
links | blank |
---|
tbstyle | top |
---|
diagramDisplayName | API - Fluxo 2 |
---|
lbox | true |
---|
diagramWidth | 1206 |
---|
revision | 5 |
---|
|
...