square / square/wire

JSON Schema generator needed

Open
#683 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Kotlin
Stars
4.4k
Forks
627
Avg merge
3d 15m
Merged PRs (30d)
20

Description

Can we get a reflection based JSON schema generator? The gson support for (de)serializing into JSON is nice, but it would be awesome if we could also point those JSON clients to a JSON schema document explaining what the client should expect.

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.

Research direction

Start by reviewing the existing Gson support and its reflection-based entry points. Clarify which JSON clients and schema document shapes must be supported, then define acceptance criteria for generated schemas and compare them with representative serialized JSON.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.