From 31a32499a7c5ff79d3fc24bd00c8aa229a0615a3 Mon Sep 17 00:00:00 2001
From: zhulijian <zhulijian1@huawei.com>
Date: Mon, 9 Mar 2020 19:21:01 +0800
Subject: [PATCH] support describing response headers (#426)

---
 route_builder.go | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/route_builder.go b/route_builder.go
index 46790076..c304670c 100644
--- a/route_builder.go
+++ b/route_builder.go
@@ -176,6 +176,15 @@ func (b *RouteBuilder) Returns(code int, message string, model interface{}) *Rou
 	return b
 }
 
+// ReturnsWithHeaders is similar to Returns, but can specify response headers
+func (b *RouteBuilder) ReturnsWithHeaders(code int, message string, model interface{}, headers map[string]Header) *RouteBuilder {
+	b.Returns(code, message, model)
+	err := b.errorMap[code]
+	err.Headers = headers
+	b.errorMap[code] = err
+	return b
+}
+
 // DefaultReturns is a special Returns call that sets the default of the response.
 func (b *RouteBuilder) DefaultReturns(message string, model interface{}) *RouteBuilder {
 	b.defaultResponse = &ResponseError{
@@ -205,9 +214,27 @@ type ResponseError struct {
 	Code      int
 	Message   string
 	Model     interface{}
+	Headers   map[string]Header
 	IsDefault bool
 }
 
+// Header describes a header for a response of the API
+//
+// For more information: http://goo.gl/8us55a#headerObject
+type Header struct {
+	*Items
+	Description string
+}
+
+// Items describe swagger simple schemas for headers
+type Items struct {
+	Type             string
+	Format           string
+	Items            *Items
+	CollectionFormat string
+	Default          interface{}
+}
+
 func (b *RouteBuilder) servicePath(path string) *RouteBuilder {
 	b.rootPath = path
 	return b