Entrada de función : aplicación de gestión de API/seleccionar un elemento/otros menús/sincronización de fuente de datos (los documentos de API se generan automáticamente)

Esta función puede generar automáticamente documentos API basados en la información API de la fuente de datos configurando la información de la fuente de datos.

Actualmente admite 5 fuentes de datos: Swagger URL, apiDoc, Github, gitlab, code cloud .

URL de Swagger y fuente de datos apiDoc

El método de configuración de la fuente de datos de Swagger URL y apiDoc es el mismo, solo necesita completar el nombre de la fuente y la dirección de acceso del archivo json.

análisis de campo
Nombre de la fuente: el nombre utilizado para identificar la fuente; ingresar un nombre no afecta el efecto de sincronización.
dirección de acceso al archivo json: URL de Swagger o dirección Json generada por apiDoc. Tenga en cuenta que la dirección debe ser accesible a través de la red y la dirección debe poder devolver datos de tipo JSON; de lo contrario, se le indicará que no se puede acceder a la dirección.

Gitlab y github y fuente de datos de nube de código

La configuración de la fuente de datos de la clase de almacén de código es relativamente complicada. El sistema leerá de forma remota el código en el almacén y generará automáticamente el documento API correspondiente de acuerdo con el formato de anotación de código de Swagger 2.0.

análisis de campo
Los campos de configuración de fuente de datos de cada tipo de almacén de código se analizan de la siguiente manera:

GitHub

elemento de configuración	ilustrar
tipo de repositorio de código	Elija Github
Código de dirección del almacén	Complete GitHub por defecto: Construyamos desde aquí GitHub
nombre de usuario	Nombre de cuenta de Github
nombre del almacén	Nombre del almacén del repositorio de Github
acceder a la clave privada	Los tokens privados de almacén se generan en Configuración->Configuración de desarrollador->Tokens de acceso personal del repositorio de GitHub
rama para escanear	El valor predeterminado es la rama maestra, también puede elegir la rama de código que realmente necesita escanearse
Ruta del directorio de la API que se escaneará	Ruta de almacenamiento del código relacionado con la capa API
La ruta del directorio de la estructura de datos que necesita ser escaneada	Ruta de almacenamiento de la información de configuración relacionada con la estructura de datos
Lengua de llegada	Java o PHP
Formato de anotación	El valor predeterminado es Swagger 2.0. Para conocer el formato de los comentarios del código, consulte el siguiente formato o consulte el documento oficial swagger-php/Examples en 2f66ec81d2bc4b82c26b250b187d5e9ea07b0538 · zircote/swagger-php · GitHub
Método de sincronización de datos	Actualmente, hay tres opciones: actualización incremental, actualización completa y solo agregar nuevas API. La plataforma de gestión de I + D de API recomienda la actualización incremental. Después de cada sincronización, el sistema generará automáticamente la versión histórica de la API para facilitar los documentos de reversión, así que no te preocupes aunque cometas un error.
El estado predeterminado para generar documentación API	El estado predeterminado de la API recién agregada obtenida mediante el escaneo, el valor predeterminado es el estado habilitado

GitLab

elemento de configuración	ilustrar
tipo de repositorio de código	Elija Gitlab
Código de dirección del almacén	Versión en línea con cable de GitLab y los usuarios crean su propia versión de nube privada. La versión en línea puede completar The DevSecOps Platform \| GitLab . Si es GitLab implementado por usted mismo, escriba el nombre de dominio o el puerto IP
Projecto ID	ID de proyecto en GitLab
acceder a la clave privada	Se puede obtener a través de la función Access Tokens de GitLab
rama para escanear	El valor predeterminado es la rama maestra, también puede elegir la rama de código que realmente necesita escanearse
Ruta del directorio de la API que se escaneará	La ruta de almacenamiento de los códigos relacionados con la capa API, por ejemplo: src/main/java/com/example/demo/controller
La ruta del directorio de la estructura de datos que necesita ser escaneada	Ruta de almacenamiento de la información de configuración relacionada con la estructura de datos, por ejemplo: src/main/java/com/example/demo/model
Lengua de llegada	Java o PHP
Formato de anotación	El valor predeterminado es Swagger 2.0. Para conocer el formato de los comentarios del código, consulte el siguiente formato o consulte el documento oficial swagger-php/Examples en 2f66ec81d2bc4b82c26b250b187d5e9ea07b0538 · zircote/swagger-php · GitHub
Método de sincronización de datos	Actualmente, hay tres opciones: actualización incremental, actualización completa y solo agregar nuevas API. La plataforma de gestión de I + D de API recomienda la actualización incremental. Después de cada sincronización, el sistema generará automáticamente la versión histórica de la API para facilitar los documentos de reversión, así que no te preocupes aunque cometas un error.
El estado predeterminado para generar documentación API	El estado predeterminado de la API recién agregada obtenida mediante el escaneo, el valor predeterminado es el estado habilitado

nube de código

elemento de configuración	ilustrar
tipo de repositorio de código	Elija la nube de código
Código de dirección del almacén	La URL de acceso al almacén del proyecto, como Gitee: plataforma de eficiencia de I+D de DevOps a nivel empresarial.
nombre del espacio	El nombre del espacio que creó en Code Cloud, como eolinker
nombre del almacén	El nombre del almacén en el espacio, como goku.
acceder a la clave privada	Token privado de Code Cloud
rama para escanear	El valor predeterminado es la rama maestra, también puede elegir la rama de código que realmente necesita escanearse
Ruta del directorio de la API que se escaneará	Ruta de almacenamiento del código relacionado con la capa API
La ruta del directorio de la estructura de datos que necesita ser escaneada	Ruta de almacenamiento de la información de configuración relacionada con la estructura de datos
Lengua de llegada	Java o PHP
Formato de anotación	El valor predeterminado es Swagger 2.0. Para conocer el formato de los comentarios del código, consulte el siguiente formato o consulte el documento oficial swagger-php/Examples en 2f66ec81d2bc4b82c26b250b187d5e9ea07b0538 · zircote/swagger-php · GitHub
Método de sincronización de datos	Actualmente, hay tres opciones: actualización incremental, actualización completa y solo agregar nuevas API. La plataforma de gestión de I + D de API recomienda la actualización incremental. Después de cada sincronización, el sistema generará automáticamente la versión histórica de la API para facilitar los documentos de reversión, así que no te preocupes aunque cometas un error.
El estado predeterminado para generar documentación API	El estado predeterminado de la API recién agregada obtenida mediante el escaneo, el valor predeterminado es el estado habilitado

configuración de sincronización

Después de completar la configuración del origen de datos, debe configurar la lógica empresarial de sincronización.

Método de sincronización de datos

Admite tres métodos de sincronización: actualización incremental, actualización completa y solo agregar nuevas API

actualización incremental
Al actualizar los datos, juzgue si la API y el contenido de la API han cambiado y solo sincronice la parte modificada. Como agregar nuevas API y modificar el contenido de la API modificado. Aplicable a la mayoría de las situaciones, elija este método cuando no sepa cómo elegir para evitar la pérdida de datos.
Debido a que se requiere una comparación incremental, al seleccionar la actualización incremental, debe seleccionar un identificador único para evaluar la API. Se pueden seleccionar tres métodos: identificación de la interfaz (operationId), dirección de la interfaz combinada con el modo de solicitud y nombre de la interfaz.
Actualización completa
Al actualizar los datos, borre todas las API del proyecto existente y vuelva a importar la información de la API desde la fuente de datos. Tenga en cuenta que este método provocará la pérdida del contenido de la API editado anteriormente y solo es aplicable para volver a importar toda la información de la API en una pequeña cantidad de casos.
Agregar solo nueva API
Al actualizar los datos, determine si hay una nueva API, si hay una nueva API, agregue una nueva API, pero no eliminará la API que no existe y no actualizará el contenido del documento de la API existente.

Configuración de estado y nueva agrupación de documentos

Independientemente del método de sincronización de datos que elija, puede configurar el estado del documento recién generado y el estado del documento modificado por separado. La opción de estado es el estado de todos los documentos API.

También podemos establecer a qué grupo se agregan los documentos recién generados, y el valor predeterminado es el directorio raíz.

Diario de autoaprendizaje de Apikit: genere automáticamente la documentación de la API