Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generated documentation using a API description language #1

Open
4 tasks
jk opened this issue Oct 30, 2011 · 0 comments
Open
4 tasks

Generated documentation using a API description language #1

jk opened this issue Oct 30, 2011 · 0 comments
Assignees
@jk
Labels
Feature
Milestone
2.0.0

Comments

@jk
Copy link
Owner

jk commented Oct 30, 2011

The source code as a documentation is fine if you're the only one who is using the API. But when you open up to third-party, the absence of a good documentation will render your API useless to others. Since jk/restserver manage its functionality via DocBlock comments it's straight forward to generate a comprehensive documentation from it.

I have something like http://swagger.io/ in mind. But other languages are already worth to consider.

Implement one or more of the following API specification/description languages:
@ghost ghost assigned jk Oct 30, 2011
jk added a commit that referenced this issue Jan 3, 2015
@jk
More scruitinizer modifications #1
f0cb4b4
jk pushed a commit that referenced this issue Jan 3, 2015
@jacwright
Merge pull request #1 from jk/master
2b96fb3 
Merging some fixes, dot syntax for format, and .htaccess sample from Jens Kohl.
@jk jk modified the milestones: 2.0.0, 1.1.0 Feb 5, 2015
@jk jk changed the title Generated documentation Generated documentation using a API description language Feb 24, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jk jk

Labels
Feature
Projects
None yet
Milestone
2.0.0
Development

No branches or pull requests
1 participant
@jk