GenieFramework/Genie.jl

Add swagger generation

Open

#135 opened on May 2, 2019

View on GitHub
 (9 comments) (3 reactions) (1 assignee)Julia (2,408 stars) (186 forks)batch import
feature requesthelp wanted

Description

Describe the solution you'd like I would love it if Genie.jl auto-generated a swagger documentation page like plumber does for the R ecosystem. (Or does it already, sorry if I just missed that.)

Describe alternatives you've considered Swagger.jl, but all the Java makes it seem like a tough dependency.

Contributor guide

Tech stack
None
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JuliaGenie.jl framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
The issue requests automatic Swagger documentation generation for Genie.jl. Existing comments may discuss implementation approaches. Review the Genie.jl source code for route reflection and consider integrating with OpenAPI.jl or similar Julia packages. Check if any linked forks or branches exist. Engage with the assigned developer for progress.