grpc-ecosystem/grpc-gateway

Feature request: protoc-gen-swagger pluggable validation

Open

#1,093 opened on 2019年12月5日

GitHub で見る
 (14 comments) (2 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
4
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
3-5 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.