Station

Publicação da API

Exponha as APIs de forma segura e clara ao público certo com a documentação e os processos corretos.

A publicação é mais do que a disponibilização - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz.

Sua rota no mapa

Mapa do metrô

Select a cycle, station, or stakeholder to open its permanent method page.

EstratégicoGovernançaConsumidorTécnicoExperiência do utilizadorExperiência do utilizadorInformações sobre o mercadoInformações sobre o mercadoObjectivos comerciaisObjectivos comerciaisAnálise competitivaAnálise competitivaVisão do ecossistemaVisão do ecossistemaInfraestrutura escalávelInfraestrutura escalávelLegal e ConformidadeLegal e ConformidadeSegurança e privacidadeSegurança e privacidadeNormas de conceçãoNormas de conceçãoGestão de fornecedoresGestão de fornecedoresConceção de contratosConceção de contratosDesenvolvimentoDesenvolvimentoCI/CDCI/CDAutomatização de testesAutomatização de testesGestão de versõesGestão de versõesAcordos de serviçoAcordos de serviçoAdoção pelo consumidor da APIAdoção pelo consumidor da APIPromoção da APIPromoção da APIIntegração de parceirosIntegração de parceirosMentalidade APIMentalidade APIFunções e responsabilidadesFunções e responsabilidadesUpskillingUpskillingDiretrizes operacionaisDiretrizes operacionaisGestão de portfólioGestão de portfólioOrçamento e gestão de recursosOrçamento e gestão de recursosEstratégia de produtos API - Transforme APIs em produtos estratégicos1Estratégia de produtoAPIExperiência do consumidor da API - Conceção para os utilizadores reais da sua API2Experiência doconsumidor da APIArquitetura da plataforma API - Arquitetar APIs para escalabilidade e reutilização3Arquitetura daplataforma APIConceção da API - Conceber APIs que proporcionem valor4Conceção da APIEntrega da API - Fornecer APIs seguras e fiáveis5Entrega da APIAuditoria de API - Auditoria de APIs para conformidade e qualidade6Auditoria da APIPublicação de API - Publique APIs com confiança7Publicação da APIMonitorização e melhoria - para valor API8Monitorizacao e melhoriada APILinha oportunidades de negócioLinha de arquitetura da plataformaLinha de conceção de APILinha de entregaLinha de publicação e adoçãoLinha de modelo operacional

Selected station: Publicação de API - Publique APIs com confiança

Pessoas a envolver

Recursos relacionados

Resultados

  • APIs publicadas no ambiente correto (privado, parceiro, público)
  • Processos claros de integração e registo da API
  • Documentação, modelos e políticas de segurança disponíveis
  • APIs prontas para escala e governação

Critérios do percurso

Critérios de entrada

  • A arquitetura, plataforma e estilo de implementação escolhidos foram validados com as partes interessadas relevantes de arquitetura, segurança e plataforma.
  • O desenho da interface e as capacidades expostas são rastreáveis ao valor de negócio e às necessidades dos utilizadores.
  • A interface e as suas capacidades estão documentadas de forma suficientemente clara para revisão, auditoria e onboarding.
  • O desenho da interface segue os standards e convenções de desenho acordados.
  • O contrato de interface foi validado e testado face aos requisitos funcionais e não funcionais.

Critérios de saída

  • A solução passa as verificações de qualidade, segurança, conformidade e prontidão.
  • As conclusões da auditoria e as decisões de correção são partilhadas com as partes interessadas relevantes.
  • A capacidade está pronta para ser publicada ou disponibilizada através do mecanismo de entrega selecionado.
  • A documentação orientada para os utilizadores e os materiais de onboarding estão prontos.

Como é o sucesso na prática

Permitir que as APIs sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade.

  1. Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API.
  2. Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo.
  3. Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores. — Lista de verificação de auditoria da API

Metro lines

Recursos relacionados

Browse the resources selected for Publicação da API; the summary above explains how they support this station’s work.

Recursos

Resources for Publicação da API

checklist

Lista de verificação de auditoria da API

Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.

Resultados

  • Melhor compreensão dos princípios da lista de controlo de auditoria da API
  • Abordagem normalizada utilizando a lista de verificação de auditoria da API
  • Melhoria da implementação das práticas de API relacionadas

Como funciona

  1. Utilize a lista de verificação de auditoria da API para garantir que a conceção da API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.
  2. Realize auditorias para avaliar a cobertura do ciclo de vida e verificar se a API satisfaz os padrões de negócio, conceção e operacionais.
  3. Certifique-se de que a documentação, os modelos de segurança, a configuração do gateway e os requisitos legais estejam claramente definidos, validados e comprovados por evidências.

Relevant cycles

Ciclo de Produto de Capacidades

Um ciclo para transformar capacidades de negócio em capacidades digitais reutilizáveis antes de selecionar o estilo de implementação.

Ciclo de Produto de API

A jornada APIOps Cycles focada em API para transformar APIs em produto, concebê-las, entregá-las, publicá-las e melhorá-las.

Ciclo de Automação

Um ciclo para identificar, conceber, entregar, capacitar e melhorar oportunidades de automação.