Spring Data

Spring Data Search API

The Search API from Spring Data — 2 operation(s) for search.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.spring.io/spring-data/rest/docs/current/reference/html/
📖
APIReference
https://docs.spring.io/spring-data/rest/docs/current/api/
📖
GettingStarted
https://spring.io/guides/gs/accessing-data-rest/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/spring-data/refs/heads/main/openapi/spring-data-search-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/spring-projects/spring-data-rest

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/spring-data/refs/heads/main/json-schema/spring-data-paged-resource-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/spring-data/refs/heads/main/json-structure/spring-data-hal-resource-structure.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/spring-data-search-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

spring-data-search-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Spring Data REST Association Search API
  description: Spring Data REST exposes Spring Data repositories as hypermedia-driven RESTful resources following the HATEOAS constraint. It provides automatic endpoint generation for CRUD operations, pagination, sorting, projections, and custom query endpoints derived from repository methods.
  version: 4.3.0
  contact:
    name: Spring Team
    url: https://spring.io/projects/spring-data-rest
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080
  description: Default local server
tags:
- name: Search
paths:
  /{repository}/search:
    get:
      operationId: listSearchMethods
      summary: List Search Methods
      description: Returns all custom query methods exposed by the repository
      tags:
      - Search
      parameters:
      - name: repository
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Search methods available
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/SearchResource'
  /{repository}/search/{method}:
    get:
      operationId: executeSearchMethod
      summary: Execute Repository Search Method
      description: Executes a custom repository query method
      tags:
      - Search
      parameters:
      - name: repository
        in: path
        required: true
        schema:
          type: string
      - name: method
        in: path
        required: true
        schema:
          type: string
        description: Query method name as exposed by the repository
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 0
      - name: size
        in: query
        required: false
        schema:
          type: integer
          default: 20
      - name: sort
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Search results
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/PagedResource'
        '404':
          description: Search method not found
components:
  schemas:
    Resource:
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/Links'
      additionalProperties: true
    PagedResource:
      type: object
      properties:
        _embedded:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/Resource'
        _links:
          $ref: '#/components/schemas/Links'
        page:
          $ref: '#/components/schemas/PageMetadata'
    PageMetadata:
      type: object
      properties:
        size:
          type: integer
          description: Number of items per page
        totalElements:
          type: integer
          description: Total number of items
        totalPages:
          type: integer
          description: Total number of pages
        number:
          type: integer
          description: Current page number (zero-based)
    Links:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Link'
    Link:
      type: object
      properties:
        href:
          type: string
          description: The URI of the link
        templated:
          type: boolean
          description: Whether the href is a URI template
    SearchResource:
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/Links'