swagger-api / swagger-api/swagger-ui
Create a plugin to explore plugins.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
In order to explore the extension points of swagger-ui, its likely useful to have a little helper plugin that can...
- Show all components ( maybe even mount them ? )
- Show all actions,selectors ( reducers are harder )
- Show current state, allow edits
Currently we can do most of this through window.ui which ( by default ) is where we expose an instance swagger-ui.
Redux DevTools (super cool) also helps watch the actions that go through, but the actions there don't show the action-creator interface ( things like parameters, the actual name of the action as it would be called from code ).
Since the system ( the swagger-ui instance ) is a simple object, that exposes all this, as can be seen with window.ui it should be trivial/fun to get something up quickly and its really about the extra value we can add such as mounting components, that we'd get the most value out of it.
Guestimate of work: < Normal for initial. non-trivial to get component mounting.
@shockey as always, shout if you have any thoughts.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the exposed window.ui swagger-ui instance and inspect the extension points it provides for components, actions, selectors, and state. Review the Redux DevTools comparison in the issue, then define a plugin that exposes these areas and determine whether component mounting is feasible; done means the exploration workflow works through a swagger-ui plugin.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, redux
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100