No desenvolvimento, comunicação e colaboração de APIs, a documentação de API é, logicamente, o padrão, mas, na prática, existe o problema de circular ficheiros em formatos Word ou PDF. Por este motivo, defende-se a utilização de documentação online para melhorar a eficiência da comunicação entre equipas.
Mude para o módulo Share Docs no lado esquerdo.Clique em "New" para criar uma nova Partilha rápida. Um projeto suporta várias Partilhas rápidas diferentes, que podem ser distribuídas a diferentes colaboradores. Todos os membros da equipa podem ver todas as Partilhas rápidas criadas por todos.Na janela pop-up Nova partilha, pode personalizar as seguintes opções:
Título: O nome desta partilha, visível apenas dentro da equipa Apidog, utilizado para identificação interna, não visível na documentação partilhada.
Ambientes: Escolha os ambientes disponíveis no documento online. Por predefinição, nenhum ambiente está selecionado. Pode selecionar vários ambientes. Os ambientes selecionados ficarão visíveis para os leitores na documentação e podem ser utilizados para enviar pedidos ao usar "Try it out".
Se selecionar o ambiente de mock na Cloud ao criar a documentação, isso é equivalente a ativar um ambiente sandbox simples para os leitores da documentação.
Conteúdo do documento: O documento tem dois componentes opcionais: URL base e Exemplos de pedido. Pode escolher se pretende apresentá-los no documento.
URL base: Este é o URL base definido no ambiente. Se selecionado, cada interface no documento mostrará o URL completo; se não for selecionado, o URL no documento começará com "/".
Exemplos de pedido: Se deve apresentar código de exemplo para chamar pedidos. Consulte Exemplos de pedido para obter detalhes.
Permitir exportação de dados: Se deve permitir que os leitores exportem dados em formato OAS/Markdown/HTML/Apidog.
Âmbito a partilhar: Escolha que endpoints de API e Markdown incluir nesta partilha. Pode selecionar por diretório ou filtrar e excluir por etiqueta.
Segurança: Pode definir se é necessária uma palavra-passe para aceder a este documento e o prazo de validade deste documento. Se não for selecionado nenhum prazo de validade, nunca expira.
Mostrar campos da API: Pode definir se estes campos são apresentados no documento. Inclui: Responsáveis, Hora de atualização, OperationId, Ligação original, Autorização necessária.
Idioma: A definição de idioma aqui afetará o texto fixo funcional no documento, como "Query Params", "Request samples", etc., mas não afetará o texto escrito no conteúdo da documentação da API.
Definições avançadas: Pode definir aqui Ocultar botão "Try it out" e Ocultar "Powered by Apidog".
A Partilha rápida suporta "partilhar a pasta inteira". Isto é adequado para cenários em que, depois de partilhar a ligação, pode ter adicionado ou removido documentos na pasta e pretende que os colaboradores consigam ver estas alterações de forma sincronizada.Em "Âmbito a partilhar", quando seleciona "Seleção manual", pode ver "partilhar a pasta inteira". Se ativado, os colaboradores verão sempre todos os documentos na pasta, sem que tenha de modificar manualmente o âmbito de partilha após adicionar documentos.
Pode escolher se pretende apresentar este módulo ao criar a partilha. Pode personalizar os Exemplos de pedido. Eis como:
1.
Em Definições do projeto - Definições de funcionalidades - Definições de funcionalidades de endpoint - Campos de endpoint, ative o campo Exemplos de pedido.
2.
Em seguida, em Endpoint - Editar, aparecerá um módulo Exemplos de pedido no fim.
3.
Pode clicar em Adicionar exemplo de pedido aqui para adicionar exemplos nos idiomas de que necessita. Depois, estes aparecerão na documentação.
