Podemos criar um modelo de documento de API e usar o modelo de documento de API para adicionar documentos de API para atingir o objetivo de melhorar a eficiência da criação de documentos de API e padronizar o formato dos documentos de API.
Esta função é uma função de versão paga e precisa ser atualizada para a versão corporativa para usá-la.
Criar um modelo de documentação da API
Entrada de função : aplicativo de gerenciamento de API / selecione um projeto / menu de recurso público / menu secundário de modelo de documento de API / clique em "+ Adicionar modelo de API"
O conteúdo editável do modelo de documento da API é consistente com o conteúdo de edição do documento da API e a experiência da operação é sincronizada. Para operações de edição específicas, consulte "Editar documentos da API" .
-
Hierarquia de modelos de documentação da API
-
Os modelos de documentos da API são recursos públicos e todos os recursos públicos têm propriedade hierárquica, que é dividida em nível de módulo de aplicativo e nível de projeto. Os recursos públicos no nível do módulo de aplicativo podem ser usados por todos os projetos e os recursos públicos no nível do projeto só podem ser usados pelo projeto atual.
-
O modelo de documento da API no nível do módulo do aplicativo pode ser criado e editado no menu "Modelo de documento da API" do menu secundário de recurso público da interface do aplicativo de gerenciamento de API.
usar modelo
Entrada de função : aplicativo de gerenciamento de API / menu de documento da API / clique no botão suspenso ao lado do botão "+ API" / selecione "Adicionar API do modelo"
Depois de selecionar um modelo, o conteúdo do modelo de API é importado automaticamente para o documento de API recém-criado. Deve-se observar que os modelos não estão associados a documentos de API recém-criados. Ou seja, alterações subsequentes no conteúdo do modelo não afetarão o conteúdo do documento da API.
