JS-Hub-ZW / JS-Hub-ZW/hackathon-backend

Generate API file

Open
#15 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue hacktoberfest
Dominant language
JavaScript
Stars
1
Forks
4
PR merge metrics
No merged PRs in 30d

Description

We want to generate an API file which lists all APIs. The output can can be openapi file, insomnia file and postman file

This should make it easier for frontend devs and mobile devs to integrate

Contributor guide

No contributing guide indexed for this repository

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

Read the repository's existing API route definitions and determine whether the project should generate OpenAPI, Insomnia, or Postman output. Define how all routes will be represented and how the generated file will be consumed by frontend and mobile developers. Done means the chosen API file is generated and includes the project's APIs.

Written by the indexing model from the issue text.

Assessment

Tech stack
express, javascript, node.js, openapi
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.