Páginas de endpoints
Las páginas de operaciones de API se renderizan a partir de la fuente OpenAPI o Swagger correspondiente. Cada página de operación contiene solo frontmatter: una clave
openapi que apunta a la especificación renderizada, más las claves opcionales title y description que reemplazan los valores renderizados:
/en/ o /pt/ correspondiente en la página traducida. El método y la ruta se mantienen idénticos en todos los idiomas.
Mintlify renderiza los detalles de la operación desde la especificación. No dupliques manualmente parámetros, ejemplos de solicitud y respuesta, cuerpos de error ni descripciones de endpoints en una página de operación.
Actualizar una operación
Actualiza primero el contrato de API canónico del servicio. Luego sincroniza las especificaciones renderizadas y mantén los stubs de operación alineados con el método y la ruta resultantes. Esto mantiene la referencia precisa en todos los idiomas compatibles.
Antes de publicar
- Verifica que la especificación renderizada contenga la operación.
- Usa el mismo método y ruta en cada idioma.
- Mantén las descripciones de comportamiento, los esquemas y los ejemplos en el contrato del servicio, no en una página de operación escrita manualmente.