swagger-api / swagger-api/swagger-codegen

Add auto-generated documentation

Open
#2,359 13 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Client: Bash Client: C++ Client: Clojure Client: Flash/ActionScript Client: Groovy Client: Scala Client: Swift Client: TypeScript Enhancement: Feature Feature List: API clients Feature: Documentation help wanted
Dominant language
Mustache
Stars
17.8k
Forks
6k
No merged PRs in 30d

Description

We've add capabilities to generate documentation files (markdown) for API and model files in the Perl code generator: #2320, #2343

If anyone has cycle to add the documentation to the following languages, please reply to let us know:

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

Review the documentation-generation work in #2320 and #2343, then choose one unchecked language entry in the issue. Compare that language's generator templates with the existing Perl implementation and confirm how API and model documentation files are produced. Done means the selected generator produces the requested Markdown documentation and the issue is updated with the language and resulting pull request.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, bash, clojure, cpp, csharp, dart, elixir, go, groovy, java, javascript, markdown, objective-c, php, python, ruby, scala, swift, typescript
Domain
documentation, tooling
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.