Goa 更新情報 v3.7.6

概要

Goa の更新情報メモです。

Goa v3.7.6

• 差分: https://github.com/goadesign/goa/compare/v3.7.5...v3.7.6

更新内容

• gopkg.in/yaml.v2 -> gopkg.in/yaml.v3 （セキュリティの問題があったよう）
• Meta("openapi:summary", "{path}") が追加された

詳細

"openapi:summary" というメタタグは、OpenAPI Doc の summary フィールドに任意のテキストをを指定するためのものですが、{path} という特別な文字列を引数に指定すると、メソッドのパスをサマリに指定してくれるようになりました。

たとえば、こんな感じに指定すると、

var _ = Service("calc", func() {
	Description("The calc service performs operations on numbers.")
	Method("add", func() {
		Meta("openapi:summary", "{path}")

    /add/{a}/{b}:
        get:
            tags:
                - calc
            summary: /add/{a}/{b}    // ← これに展開されます
            operationId: calc#add
            parameters:

これを指定しないデフォルトでは、メソッド名とサービス名が指定されています。上の例だと

    /add/{a}/{b}:
        get:
            tags:
                - calc
            summary: add calc

となっているはずです。

今回は細かな修正だけですね。

Happy hacking!