copper-leaf / copper-leaf/kodiak

[language support] REST APIs

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
16
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Scrape comments in code from any language to create API documentation. Try to match existing comment-based models like the following tools (or just integrate with them directly):

- [apiDoc](https://apidocjs.com/)

Might want to create OpenAPI definitions and/or Postman collections based on the scraped info

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing Kodiak's existing wrappers around code documentation CLI tools and the JSON models they produce. Compare apiDoc's comment-based approach, then define which languages and output formats are in scope; done means documented support for the agreed inputs and generated API documentation, OpenAPI definitions, or Postman collections.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin, openapi, postman
Domain
api, documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.