OpenAPITools/openapi-generator

New TypeScript Koa2 server generator

Open

#3011 opened on May 27, 2019

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Java (26,243 stars) (7,516 forks)batch import
Enhancement: New generatorHacktoberfestServer: TypeScripthelp wanted

Description

We would like to create a new server generator for TypeScript Koa2:

Ref: https://github.com/dai1975/swagger-codegen-typescript-koa2#readme

cc @dai1975

Similar to how other new generators are created, we can re-engineer the new generator and template based on TypeScript Koa2 server-side code.

Contributor guide

Tech stack
typescriptnodejs
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
OpenAPI specification knowledgeTypeScriptKoa2 frameworkFamiliarity with OpenAPI Generator internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Examine existing server generators (e.g., typescript node, typescript express) in the repo for structure. Review the referenced swagger codegen typescript koa2 repo for implementation details. Understand the Mustache template system and how generators register. Implement a new generator class under modules/openapi generator/src/main/java/org/openapitools/codegen/languages/ and corresponding templates under modules/openapi generator/src/main/resources/. Consult issue comments for additional guidance.