swagger-api / swagger-api/swagger-ui

Support json editor

Open
#5,287 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Content & configuration

josdejong has an amazing jsoneditor: https://github.com/josdejong/jsoneditor

It would be really nice to use a json editor especially if you have a rich schema.

Swagger-UI configuration options:

SwaggerUI({
  jsonEditor: true
})
Is your feature request related to a problem?

I'm always frustrated when I'm typing json and not getting any help.

Describe the solution you'd like

The end goal is something like this: http://recordit.co/HgSqrKpdU3/gif/notify
https://developers.google.com/calendar/v3/reference/acl/insert

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 with the SwaggerUI({ jsonEditor: true }) configuration described in the issue and review the linked jsoneditor project and example behavior. Done should provide a JSON editor with assistance for rich schemas, matching the requested Swagger UI configuration and demonstrated interaction.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.