sumory/lor

Auto generate API doc by lor specification

Open

#12 opened on Jul 26, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Lua (945 stars) (174 forks)batch import
enhancementhelp wanted

Description

Lor is easy to expose a restful api for backend management. It would be nice to have a cli helper to generate api doc. I would recommend Swagger JSON format, because it would be parsed and have a nice test interface.

Contributor guide

Tech stack
None
Domain
backendclidocumentation
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.
3-5 days
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
Understanding of Lor frameworkFamiliarity with Swagger/OpenAPI spec
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how Lor defines routes and handlers. Look for existing route introspection or middleware. Design a CLI tool that scans Lor application code or annotations to extract route metadata (path, method, parameters, response). Output Swagger JSON format. Consider using OpenAPI 2.0 for simplicity. Test with sample Lor app.
Auto generate API doc by lor specification · sumory/lor#12 | Good First Issue