← Volver a TipoIvaController

🔧 Información del Sistema

Endpoint para obtener información sobre métodos HTTP permitidos

Descripción General

El endpoint OPTIONS proporciona información sobre los métodos HTTP permitidos en el controlador TipoIvaController. Este endpoint es útil para que los clientes descubran qué operaciones están disponibles sin necesidad de realizar llamadas reales a la API.

🎯 Propósito del Endpoint OPTIONS

  • Descubrimiento de API: Permite a los clientes conocer los métodos disponibles
  • Preflight CORS: Respuesta a solicitudes preflight de navegadores
  • Documentación dinámica: Información actualizada sobre capacidades
  • Integración de clientes: Ayuda en la configuración de clientes HTTP
  • Validación de permisos: Verificación de métodos permitidos
  • Desarrollo y testing: Herramienta útil para desarrolladores

Endpoint Disponible

OPTIONS /Master/TipoIva

Proporciona información sobre los métodos HTTP permitidos para el controlador TipoIvaController. Este endpoint devuelve una lista de todos los métodos HTTP que están disponibles en este controlador.
Parámetros:
  • No requiere parámetros específicos
200 OK
Información de métodos HTTP devuelta exitosamente
{ "message": "Allowed HTTP methods returned" }
200 OK
Headers de respuesta incluyen:
Allow: GET, POST, PUT, DELETE, OPTIONS

Métodos HTTP Permitidos

📋 Lista de Métodos Disponibles

  • GET: Consulta y recuperación de datos
  • POST: Creación de nuevos recursos
  • PUT: Actualización de recursos existentes
  • DELETE: Eliminación de recursos
  • OPTIONS: Información sobre métodos permitidos

🎯 Detalles de Implementación

  • Header Allow: Se incluye en la respuesta HTTP
  • Respuesta JSON: Mensaje de confirmación
  • Sin autenticación: No requiere credenciales
  • Sin parámetros: No necesita parámetros de entrada
  • Respuesta inmediata: Procesamiento rápido
  • Documentación Swagger: Incluido en la documentación OpenAPI

Casos de Uso

🎯 Escenarios Comunes

  • Desarrollo de clientes: Descubrir capacidades de la API
  • Testing automatizado: Verificar métodos disponibles
  • Integración de sistemas: Configurar clientes HTTP
  • Debugging: Diagnosticar problemas de CORS
  • Documentación dinámica: Generar documentación automática
  • Validación de permisos: Verificar acceso a métodos

⚠️ Consideraciones Técnicas

  • CORS: Importante para aplicaciones web cross-origin
  • Cache: Las respuestas pueden ser cacheadas por navegadores
  • Performance: Respuesta rápida sin procesamiento complejo
  • Seguridad: No expone información sensible
  • Compatibilidad: Funciona con todos los clientes HTTP estándar

Ejemplos de Uso

🔧 Ejemplo con cURL

curl -X OPTIONS \ http://localhost:5000/Master/TipoIva \ -H "Accept: application/json"

🔧 Ejemplo con JavaScript

fetch('/Master/TipoIva', { method: 'OPTIONS', headers: { 'Accept': 'application/json' } }) .then(response => { console.log('Allowed methods:', response.headers.get('Allow')); return response.json(); }) .then(data => console.log(data));

🔧 Ejemplo con C#

using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Options, "http://localhost:5000/Master/TipoIva"); request.Headers.Accept.Add( new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json")); var response = await client.SendAsync(request); var allowedMethods = response.Headers.GetValues("Allow").FirstOrDefault(); Console.WriteLine($"Allowed methods: {allowedMethods}");

Integración con Swagger

📚 Documentación OpenAPI

  • Swagger UI: Incluido en la interfaz de documentación
  • OpenAPI Spec: Generado automáticamente
  • Descripción: Documentación XML incluida
  • Respuestas: Definidas con códigos de estado
  • Ejemplos: Incluidos en la documentación

🎯 Características de Swagger

  • Summary: "Provides the allowed HTTP methods for this controller."
  • Description: "Returns the allowed HTTP methods for the TipoIvaController."
  • Response: 200 OK con descripción
  • Tags: Incluido en la categorización