OpenAPITools/openapi-generator

[REQ] Add support for C# Refit

Open

#3,581 opened on Aug 7, 2019

View on GitHubContributor guide
 (11 comments) (24 reactions) (0 assignees)Java (7,516 forks)batch import
Enhancement: FeatureHacktoberfesthelp wanted

Repository metrics

Stars
 (26,243 stars)
PR merge metrics
 (Avg merge 9d 1h) (123 merged PRs in 30d)

Description

Refit is probably the most lightweight solution for implementing .NET backend API calls. We would need to generate only the models and interfaces (with the attribute metadata).

Contributor guide

Research direction
Examine the existing C# generators (e.g., csharp netcore) in the openapi generator repository. Understand how Mustache templates are used to generate API interfaces and models. Then, study the Refit library's attributes and interface conventions. Implement a new generator module by copying an existing C# generator, modifying templates to emit Refit attributes (e.g., [Get], [Post], [Header]), and register the generator in the codegen configuration.
Tech stack
javacsharp
Domain
backendapitooling
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaC#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45