Api-blueprint: O APIARY permite vários hosts no mesmo projeto

Criado em 8 mar. 2018  ·  9Comentários  ·  Fonte: apiaryio/api-blueprint

Oi,

Estou tentando adicionar dois hosts no mesmo projeto.
Host 1: https://abc.com/
Host 2: https://efg.com/

Atualmente posso trabalhar com um host usando "HOST: https://abc.com ", mas preciso de dois hosts configurados no mesmo projeto. Existe alguma maneira de definir dois hosts no mesmo projeto?

Desde já, obrigado. Por favor me ajude com isso.

Cumprimentos,
Teja

Apiary.io

Comentários muito úteis

alguma atualização disso?

Todos 9 comentários

Também curioso sobre isso. Estamos usando vários ambientes de teste e poder alternar entre eles para encontrar diferenças é fundamental.

Não estamos apoiando isso no momento, mas estamos trabalhando em soluções que tornarão isso possível no futuro.

alguma atualização disso?

Já existem soluções para este problema?

Não é público; fazemos um brainstorm sobre como resolver esse problema e não temos certeza de que vários HOSTs sejam a solução correta, em oposição a separar as questões de design e implantação.

@Almad , descreverei meu caso de uso para dar algum feedback em relação a esse problema.

Nosso caso de uso do Apiário é puramente incorporar uma documentação bonita ao nosso painel de desenvolvedor. Não estamos planejando usar nenhuma funcionalidade adicional, plug-ins ou extensões no momento. Usamos vários subdomínios para diferentes partes do nosso sistema (microsserviços), por exemplo, autenticação, faturamento, estatísticas, recuperação de recursos, etc. Como você pode ver cada subdomínio é responsável por um domínio diferente.

O que parece mais atraente no Apiary é a funcionalidade do console. Você pode descrever pontos de extremidade e os usuários finais podem experimentá-los por meio do console. Ele também adiciona uma opção para alterar os idiomas e copiar o código de exemplo em diferentes idiomas.

No entanto, sem a opção de usar vários subdomínios, ficamos apenas com algumas opções:

  • Use documentos diferentes por micro-serviço. Mas então a documentação está espalhada por todo o lugar. É difícil acompanhar. E a ligação entre eles não é trivial.
  • Não use a referência de forma alguma. Oculte o console enquanto incorpora a documentação. A desvantagem é, obviamente, não mostrar o console. Então, fico pensando no próximo ponto:
  • Construir a documentação da API, projetamos nós mesmos sem usar terceiros.

Nenhuma das opções parece ótima. Alguma recomendação para o nosso caso?

Haverá uma solução para isso, mas infelizmente não posso falar sobre isso e dar prazos porque a SEC e os advogados :(

O futuro previsível daria esperança suficiente?

Há algum progresso?

O suporte para host object foi adicionado aos elementos da API principalmente para oferecer suporte ao mapeamento de objetos do servidor OAS3. Fique ligado nas https://help.apiary.io/tools/interactive-documentation-v4/ atualizações do renderizador.

Eu não vi nenhum progresso para suporte no API Blueprint embora.

Esta página foi útil?
0 / 5 - 0 avaliações