Provide support for automatic documentation of request and response structure using JSON schema

Open
#43 3 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
java, spring
Domain
api, backend, documentation

Research direction

The issue identifies Spring Data REST's repository JSON Schema as the starting point; review how Spring REST Docs currently documents request and response structures. Done means establishing and implementing a workable way to generate both structures automatically from the returned schema.

Written by the indexing model from the issue text.

Description

type: enhancement

Spring Data REST can provide a JSON schema for each repository. Explore the possibility of using the returned schema to automatically generate documentation of request and response structure.

Dominant language
Java
Stars
1.2k
Forks
731
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from spring-projects/spring-restdocs

All issues in spring-projects/spring-restdocs

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.