grpc-ecosystem/grpc-gateway

Feature request: protoc-gen-swagger pluggable validation

Open

#1,093 建立於 2019年12月5日

在 GitHub 查看
 (14 留言) (2 反應) (0 負責人)Go (16,971 star) (2,250 fork)batch import
enhancementhelp wanted

描述

Our team makes heave use of https://github.com/envoyproxy/protoc-gen-validate and would like a way for those validations to end up in the swagger spec so we don't need to define them twice.

貢獻者指南

技術棧
gorest api
領域
backendapidocumentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
4
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
3-5 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
needs investigation
前置要求
GoProtocol BuffersgRPCSwagger/OpenAPI
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
20
研究方向
Investigate the existing swagger generation code in the grpc gateway repository, particularly the protoc gen swagger plugin under `protoc gen swagger/genswagger/`. Understand how the protoc gen validate library outputs validation rules and explore how they can be injected into the generated swagger spec. Review issue comments for any suggested approaches or links to similar work. Consider the use of custom protobuf options to pass validation annotations to the generator.
Feature request: protoc-gen-swagger pluggable validation · grpc-ecosystem/grpc-gateway#1093 | Good First Issue