swagger-api/swagger-codegen

Add endpoint examples defined in the spec to API servers

Open

#5,423 创建于 2017年4月19日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)HTML (12,701 star) (5,474 fork)batch import
Enhancement: FeatureFeature List: API serversServer: C-SharpServer: ErlangServer: GoServer: HaskellServer: JavaServer: NodejsServer: PHPServer: PythonServer: RubyServer: ScalaServer: Springhelp wanted

描述

Description

Similar to what we've done for SpringMVC generator, we want to add support of endpoint examples defined in the spec to the auto-generated server stubs.

Ref: https://github.com/swagger-api/swagger-codegen/pull/5411

Endpoint example support in the server generators:

  • C# (NancyFx, ASP.net Core)
  • Elixir
  • Erlang
  • Go
  • Haskell Servant
  • JavaScript/NodeJS
  • Java (MSF4J, Spring:white_check_mark:, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy)
  • PHP (Lumen, Slim, Silex, Zend Expressive)
  • Python Flask
  • Ruby (Sinatra, Rails)
  • Scala Finch
  • Scala Scalatra
Suggest a Fix

#5411 is a good reference. If anyone wants to contribute to this task, please reply to let us know. Thank you.

贡献者指南

技术栈
gojavajavascriptnodejsphppythonrubyscalacsharpelixir
领域
backendapi
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
5
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
over 1 week
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Understanding of OpenAPI spec examplesFamiliarity with swagger codegen templatesReference PR #5411
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
10
研究方向
Examine the reference PR #5411 to understand how endpoint examples were added for SpringMVC server generator. Investigate the corresponding template files (e.g., mustache templates) and codegen classes for other server generators listed. For each target language, identify where the endpoint example data is available in the OpenAPI model and modify the template to output examples. Consider contributing incrementally for one language at a time.