¿Cómo encontrar el gobierno de API?

Cuando elija editar su archivo de especificaciones, encontrará varias vistas diferentes. Uno de ellos se llama Gobernanza. En esta vista, verá los resultados de una auditoría y podrá proporcionar comentarios para cada advertencia o error según las reglas que haya establecido.

¿A qué ayudará la gobernanza de API?

Estos son los puntos clave para las mejores prácticas de API:

• Información: Asegúrese de que cada API tenga propiedades esenciales como título, descripción y otra información necesaria.

• Versionado: Refuerce el uso de versiones semánticas o basadas en fechas estándar para cada API.

• Operaciones: Asegúrese de que cada operación individual incluya un resumen, una descripción y una identificación.

• Parámetros: Estandarice el formato de los nombres de los parámetros y asegúrese de que todos los parámetros tengan descripciones adecuadas.

• Respuestas: Abogue por un conjunto común de códigos de estado, tipos de medios y respuestas de esquema en todas las API.

• Esquema: Estandarice todos los esquemas de solicitud y respuesta utilizando componentes de esquema JSON.

¿Que sigue?

Actualmente, tenemos una regla fundamental llamadaOpenAPI Best Practice. En el futuro, planeamos introducir conjuntos de reglas adicionales, incluidos OWASP Top 10 Security y conjuntos de reglas personalizados. Estén atentos a estas próximas incorporaciones.

El gobierno de API abarca más que solo diseño y estándares; gira en torno a empoderar a las personas y maximizar el valor de las API. Al utilizar la automatización, los talleres y las sesiones de capacitación, el control de API ayuda a los usuarios a desarrollar medidas de seguridad, definiciones de productos y estrategias de implementación. Para garantizar su eficacia, es crucial reconocer todos los componentes e implicaciones del gobierno de API. Para obtener más orientación, permanezca atento al blog de Apigit para conocer las próximas publicaciones sobre temas esenciales de gobernanza de API.