twisted / twisted/klein

Support for URL endpoint documentation (eg. swagger/openapi)

Open
#145 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
838
Forks
123
Avg merge
7h 58m
Merged PRs (30d)
12

Description

Hi ,
I need a help.
Is there any way to get url end point documentation, in django and flask we could use swagger for the same. Kindly suggest the best possible way to represent apis on UI similar to that, if there is any.

Regards

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

The issue names no files, tests, or entry points. Start by reviewing Klein's existing route and API documentation, then determine the desired Swagger/OpenAPI representation and UI integration scope. Done means an agreed approach is documented and the requested endpoint documentation is supported or clearly scoped.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api, documentation
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.