这是indexloc提供的服务，不要输入任何密码
Skip to content

fix: accept status code 0 as default response #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 22, 2022
Merged

fix: accept status code 0 as default response #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fa8055
fix: accept status code 0 as default response
danielgtaylor Apr 22, 2022
f7e9477
test: add default repsonse test
danielgtaylor Apr 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func (c *hcontext) WriteHeader(status int) {
if c.op != nil {
allowed := []string{}
for _, r := range c.op.responses {
if r.status == status {
if r.status == status || r.status == 0 {
for _, h := range r.headers {
allowed = append(allowed, h)
}
Expand Down Expand Up @@ -273,7 +273,7 @@ func (c *hcontext) writeModel(ct string, status int, model interface{}) {
statuses := []string{}
for _, r := range c.op.responses {
statuses = append(statuses, fmt.Sprintf("%d", r.status))
if r.status == status {
if r.status == status || r.status == 0 {
responses = append(responses, r)
if r.model != nil {
names = append(names, r.model.Name())
Expand Down
3 changes: 3 additions & 0 deletions operation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ func (o *Operation) toOpenAPI(components *oaComponents) *gabs.Container {
// responses
for i, resp := range o.responses {
status := fmt.Sprintf("%v", resp.status)
if resp.status == 0 {
status = "default"
}
doc.Set(resp.description, "responses", status, "description")

headers := resp.headers
Expand Down
16 changes: 16 additions & 0 deletions router_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,3 +462,19 @@ func TestSubResource(t *testing.T) {
// Do nothing
})
}

func TestDefaultResponse(t *testing.T) {
app := newTestRouter()

// This should not crash.
app.Resource("/").Get("get-root", "docs", NewResponse(0, "Default repsonse")).Run(func(ctx Context) {
ctx.WriteHeader(http.StatusOK)
})

w := httptest.NewRecorder()
req, _ := http.NewRequest(http.MethodGet, "/", nil)
app.ServeHTTP(w, req)

// This should not panic and should return the 200 OK
assert.Equal(t, http.StatusOK, w.Result().StatusCode)
}