From e6cd21ca848ee86ea7c0fc4463d7a09e2921d44c Mon Sep 17 00:00:00 2001
From: tan <tanmaykm@gmail.com>
Date: Tue, 5 Dec 2023 19:16:12 +0530
Subject: [PATCH 1/3] helper method to create HTTP response with code

Added a helper method to create `HTTP.Response` with a HTTP code and a `APIModel` instance.

```julia
HTTP.Response(code::Integer, o::APIModel)
```
---
 src/server.jl                  |  4 ++++
 test/client/allany/runtests.jl | 10 ++++++++++
 test/runtests.jl               |  4 ++++
 3 files changed, 18 insertions(+)

diff --git a/src/server.jl b/src/server.jl
index 51b0f8e..2e60526 100644
--- a/src/server.jl
+++ b/src/server.jl
@@ -109,6 +109,10 @@ function to_param(T, source::Vector{HTTP.Forms.Multipart}, name::String; require
     end
 end
 
+function HTTP.Response(code::Integer, o::APIModel)
+    return HTTP.Response(code, [Pair("Content-Type", "application/json")], to_json(o))
+end
+
 server_response(resp::HTTP.Response) = resp
 server_response(::Nothing) = server_response("")
 server_response(ret) =
diff --git a/test/client/allany/runtests.jl b/test/client/allany/runtests.jl
index 29aa289..7eaa2a7 100644
--- a/test/client/allany/runtests.jl
+++ b/test/client/allany/runtests.jl
@@ -4,6 +4,7 @@ include(joinpath(@__DIR__, "AllAnyClient", "src", "AllAnyClient.jl"))
 using .AllAnyClient
 using Test
 using JSON
+using HTTP
 using OpenAPI
 using OpenAPI.Clients
 import OpenAPI.Clients: Client
@@ -146,4 +147,13 @@ function test_debug()
     end
 end
 
+function test_http_resp()
+    resp = HTTP.Response(200, dog)
+
+    @test resp.status == 200
+    @test resp.headers == ["Content-Type" => "application/json"]
+    json = JSON.parse(String(copy(resp.body)))
+    @test pet_equals(OpenAPI.Clients.from_json(M.Dog, json), dog)
+end
+
 end # module AllAnyTests
\ No newline at end of file
diff --git a/test/runtests.jl b/test/runtests.jl
index 6466b66..b6fe7bd 100644
--- a/test/runtests.jl
+++ b/test/runtests.jl
@@ -149,4 +149,8 @@ include("forms/forms_client.jl")
             run_tests_with_servers && servers_running && stop_server(8081, ret, out)
         end
     end
+
+    @testset "Helper Methods" begin
+        AllAnyTests.test_http_resp()
+    end
 end

From cbadd4b6d24d17e32b7884da65a0690dea6502da Mon Sep 17 00:00:00 2001
From: tan <tanmaykm@gmail.com>
Date: Wed, 6 Dec 2023 12:39:29 +0530
Subject: [PATCH 2/3] update docs related to server response

---
 docs/src/userguide.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/src/userguide.md b/docs/src/userguide.md
index 65c542e..6da9dfd 100644
--- a/docs/src/userguide.md
+++ b/docs/src/userguide.md
@@ -198,6 +198,18 @@ Optional middlewares can be one or more of:
 The order in which middlewares are invoked is:
 `init |> read |> pre_validation |> validate |> pre_invoke |> invoke |> post_invoke`
 
+## Responses
+
+The server APIs can return the Julia type that is specified in the OpenAPI specification. The response is serialized as JSON and sent back to the client. The default HTTP response code used in this case is 200.
+
+To return a custom HTTP response code, the server API can return a `HTTP.Response` instance directly. The OpenAPI package provides a overridden constructor for `HTTP.Response` that takes the desired HTTP code and the Julia struct that needs to be serialized as JSON and sent back to the client. It also sets the `Content-Type` header to `application/json`.
+
+```julia
+HTTP.Response(code::Integer, o::APIModel)
+```
+
+Structured error messages can also be returned in similar fashion. Any uncaught exception thrown by the server API is caught and converted into a `HTTP.Response` instance with the HTTP code set to 500 and the exception message as the response body.
+
 ## Streaming Responses
 
 Some OpenAPI implementations implement streaming of responses by sending more than one items in the response, each of which is of the type declared as the return type in the specification. E.g. the [Twitter OpenAPI specification](https://api.twitter.com/2/openapi.json) that keeps sending tweets in JSON like this forever:

From 2003e053cd46abc3d078c61a3fd6c537301d616b Mon Sep 17 00:00:00 2001
From: tan <tanmaykm@gmail.com>
Date: Wed, 6 Dec 2023 12:40:27 +0530
Subject: [PATCH 3/3] update patch version

---
 Project.toml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Project.toml b/Project.toml
index c5c4689..54da3f0 100644
--- a/Project.toml
+++ b/Project.toml
@@ -4,7 +4,7 @@ keywords = ["Swagger", "OpenAPI", "REST"]
 license = "MIT"
 desc = "OpenAPI server and client helper for Julia"
 authors = ["JuliaHub Inc."]
-version = "0.1.20"
+version = "0.1.21"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"