Spring Framework Mappings API

HTTP request handler mappings

OpenAPI Specification

spring-mappings-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Spring Boot Actuator Beans Mappings API
  description: The Spring Boot Actuator API provides production-ready endpoints for monitoring and managing Spring Boot applications. It exposes health checks, metrics, environment information, configuration properties, thread dumps, HTTP traces, application info, and shutdown capabilities via RESTful endpoints. The Actuator supports customizable security, endpoint exposure controls, and integration with monitoring systems like Prometheus, Datadog, and CloudWatch. Used by operators and SREs to observe and manage deployed Spring Boot services.
  version: 3.x
  contact:
    name: Spring Team
    url: https://spring.io/support
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080/actuator
  description: Default Local Spring Boot Actuator Endpoint
security:
- basicAuth: []
tags:
- name: Mappings
  description: HTTP request handler mappings
paths:
  /mappings:
    get:
      operationId: getMappings
      summary: Get Request Mappings
      description: Returns all @RequestMapping paths, handler methods, and filters registered in the Spring application context. Useful for API discovery and debugging.
      tags:
      - Mappings
      responses:
        '200':
          description: HTTP request mappings
          content:
            application/vnd.spring-boot.actuator.v3+json:
              schema:
                $ref: '#/components/schemas/MappingsResponse'
components:
  schemas:
    MappingsResponse:
      type: object
      properties:
        contexts:
          type: object
          additionalProperties:
            type: object
            properties:
              mappings:
                type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Spring Boot Actuator Reference Documentation
  url: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html