マスターの go-swagger ヘッドを実行しています https://github.com/go-swagger/go-swagger/commit/3981236c3f6bd9eabb26f14e9d31b853d340405f
これが問題なのか、それとも私の理解不足なのかはわかりません。モデルで定義された errorMessage オブジェクトとともに、デフォルトでステータス 500 を返す healthcheck メソッドがあります。ただし、WithPayload メソッドは GetHealthcheckDefaultBodyBody 型を取ります。ここではそのうちの 1 つを作成するだけなので、それほど大きな問題ではありませんが、モデル タイプの配列を返す必要がある場合は、モデル タイプから BodyBody タイプにマップするボイラープレートを大量に作成することになります。
func ClientsGet(params clients.GetClientsParams) middleware.Responder {
results, err := repository.GetAllClients()
if err != nil {
return clients.NewGetClientsDefault(500).WithPayload(clients.GetClientsDefaultBodyBody{Message: sPtr(err.Error())})
}
return &clients.GetClientsOK{results} //does not compile as GetClientsOK accepts []*clients.GetClientsOKBodyBody not []*models.Client
}
この点で、レポのサンプル コードが生成されたコードと異なることに気付きました: /restapi/operations/todos/add_one_responses.go . ここの仕様例からコードを生成できませんでした: https://github.com/go-swagger/go-swagger/blob/3981236c3f6bd9eabb26f14e9d31b853d340405f/examples/tutorials/todo-list/server-complete/swagger.yml
私の仕様:
{
"swagger": "2.0",
"info": {
"title": "M3 Intl Maas Service",
"version": "0.1.0"
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"schemes": [
"http"
],
"definitions": {
"client": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"messageTeaser": {
"properties": {
"campaignId": {
"type": "string"
},
"clientName": {
"type": "string"
},
"footer": {
"type": "string"
},
"id": {
"type": "string"
},
"isNew": {
"type": "boolean"
},
"jobNumber": {
"type": "string"
},
"piLink": {
"type": "string"
},
"repId": {
"type": "string"
},
"summary": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title",
"summary",
"isNew",
"footer",
"jobNumber",
"clientName",
"piLink",
"repId",
"campaignId"
],
"type": "object"
},
"errorMessage": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"paths": {
"/clients": {
"get": {
"parameters": [
{
"in": "path",
"required": true,
"name": "client_id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "get client",
"schema": {
"items": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
}
},
"401": {
"description": "unauthorised"
},
"404": {
"description": "client not found"
},
"default": {
"description": "generic error response",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"tags": [
"clients"
]
},
"put": {
"parameters": [
{
"in": "path",
"required": true,
"name": "client_id",
"type": "integer"
},
{
"in": "body",
"required": true,
"name": "client",
"schema": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
}
],
"responses": {
"200": {
"description": "update client",
"schema": {
"items": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
}
},
"401": {
"description": "unauthorised"
},
"404": {
"description": "client not found"
},
"default": {
"description": "generic error response",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"tags": [
"clients"
]
},
"delete": {
"parameters": [
{
"in": "path",
"required": true,
"name": "client_id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "delete client"
},
"401": {
"description": "unauthorised"
},
"404": {
"description": "client not found"
},
"default": {
"description": "generic error response",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
},
"/clients/{client_id}": {
"get": {
"parameters": [
{
"in": "path",
"required": true,
"name": "client_id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "get client",
"schema": {
"items": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
}
},
"401": {
"description": "unauthorised"
},
"404": {
"description": "client not found"
},
"default": {
"description": "generic error response",
"schema": {
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
},
"tags": [
"clients"
]
},
"put": {
"parameters": [
{
"in": "path",
"required": true,
"name": "client_id",
"type": "integer"
},
{
"in": "body",
"required": true,
"name": "client",
"schema": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
}
],
"responses": {
"200": {
"description": "update client",
"schema": {
"items": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
}
},
"401": {
"description": "unauthorised"
},
"404": {
"description": "client not found"
},
"default": {
"description": "generic error response",
"schema": {
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
},
"tags": [
"clients"
]
},
"delete": {
"parameters": [
{
"in": "path",
"required": true,
"name": "client_id",
"type": "integer"
}
],
"responses": {
"200": {
"description": "delete client"
},
"401": {
"description": "unauthorised"
},
"404": {
"description": "client not found"
},
"default": {
"description": "generic error response",
"schema": {
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"/healthcheck": {
"get": {
"responses": {
"200": {
"description": "confirm that the service is healthy"
},
"default": {
"description": "generic error response",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"tags": [
"healthcheck"
]
}
},
"/usermessagesummary/{community_id}/{user_id}/{lang_id}": {
"get": {
"parameters": [
{
"in": "path",
"required": true,
"name": "community_id",
"type": "string"
},
{
"in": "path",
"required": true,
"name": "user_id",
"type": "string"
},
{
"in": "path",
"required": true,
"name": "lang_id",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns message summary according to criteria",
"schema": {
"items": {
"properties": {
"campaignId": {
"type": "string"
},
"clientName": {
"type": "string"
},
"footer": {
"type": "string"
},
"id": {
"type": "string"
},
"isNew": {
"type": "boolean"
},
"jobNumber": {
"type": "string"
},
"piLink": {
"type": "string"
},
"repId": {
"type": "string"
},
"summary": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title",
"summary",
"isNew",
"footer",
"jobNumber",
"clientName",
"piLink",
"repId",
"campaignId"
],
"type": "object"
}
}
},
"401": {
"description": "unauthorised"
},
"404": {
"description": "client not found"
},
"default": {
"description": "generic error response",
"schema": {
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
}