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.