Páginas filhas
  • Guia de implementacao das APIs TOTVS

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Consideramos uma API o agrupamento de endpoints que façam parte da mesma unidade de negócio, criar um novo grupo de endpoints implica em preocupações como versionamento, disponibilidade e documentação. Usamos como base a estrutura "{protocolo}://{dominio}/{api}/{produto}/{agrupador}/{versãoversao}/{recurso}". Ex: https://fluig.totvs.com/api/fluig/ecm/v1/users. A partir deste ponto deve-se considerar como regra básica a complexidade necessária para descobrir estes endpoints, ou seja, o agrupamento deve facilitar e não complicar a descoberta dos serviços.

Estrutura OAS (Open Api Specification 3.0.1):

Bloco de código
languagejs
openapi: 3.0.1
info:
  title: Estrutura de Url para API's
  description: 'Consideramos uma API o agrupamento de endpoints que façam parte da mesma unidade de negócio. Usamos como base a estrutura "{protocolo}://{dominio}/{api}/{produto}/{agrupador}/{versao}/{recurso}"'
  version: '1.0'
externalDocs:
  url: 'http://tdn.totvs.com/pages/editpage.action?pageId=271660444'
servers:
  - url: '{protocolo}://{dominio}/{api}/{produto}/{agrupador}/{versao}/{recurso}'
    variables:
      protocolo:
        default: https
        enum:
          - http
          - https
      dominio:
        default: dominio
      api:
        default: api
      produto:
        default: produto
      agrupador:
        default: agrupador
      versao:
        default: versao
      recurso:
        default: recurso
paths: {}
components: {}

Ex:

Bloco de código
languagexml
GET http://totvs.com/api/fluig/ecm/v1/documents
GET http://totvs.com/api/fluig/bpm/v1/workflows
GET http://totvs.com/api/fluig/lms/v1/classes

...