Comments (10)
Thank you for looking into this issue, and providing a workaround.
from swift-openapi-generator.
Hi @zunda-pixel,
just to confirm, you're writing a server here, right? You can return a completely arbitrary URL in the response's Location header, can you clarify why you say you can't redirect to a different domain?
from swift-openapi-generator.
Yes, I am writing a server.
Base url is keeping...
http://127.0.0.1:8080/login
-> http://127.0.0.1:8080/https%3A%2F%2Fexample2.com
from swift-openapi-generator.
Hmm, baseURL
is only a client-side concept in Swift OpenAPI Generator, not a server one. Can you describe in detail how you're testing this and how you're getting this URL?
from swift-openapi-generator.
This is sample repository that has issue I told. Please check.
https://github.com/zunda-pixel/LoginServer
openapi: '3.1.0'
info:
title: LoginService
version: 1.0.0
servers:
- url: https://example.com/
description: Example service deployment.
paths:
/login:
get:
operationId: login
responses:
'303':
description: A success response Login
headers:
location:
schema:
type: string
import OpenAPIRuntime
import OpenAPIVapor
import Vapor
struct Handler: APIProtocol {
func login(_ input: Operations.login.Input) async throws -> Operations.login.Output {
return .seeOther(.init(headers: .init(location: "https://apple.com")))
}
}
@main struct LoginServer {
static func main() async throws {
let app = Vapor.Application()
let transport = VaporTransport(routesBuilder: app)
let handler = Handler()
try handler.registerHandlers(on: transport)
try await app.execute()
}
}
from swift-openapi-generator.
Can you clarify what the issue is? The code in the project all looks correct.
What are the steps you're taking, what is the result you see, and what is the result you expect? That'll help us understand where the mismatch is.
from swift-openapi-generator.
Current Result
Expecting Result
from swift-openapi-generator.
Which HTTP client are you using? A web browser? curl?
from swift-openapi-generator.
I use a web browser.
from swift-openapi-generator.
Thank you @zunda-pixel, I was able to isolate the issue.
The problem is that OpenAPI-defined headers are serialized according to the rules of RFC6570 (details here), which dictate that non-reserved characters need to be percent encoded. However, in the Location
header, that causes the URL in the response header to be percent-encoded, and the web browser client doesn't remove the percent encoding, it seems.
As a workaround, add a middleware that removes the percent encoding of the Location header:
import OpenAPIRuntime
import OpenAPIVapor
import Vapor
import HTTPTypes
struct Handler: APIProtocol {
func login(_ input: Operations.login.Input) async throws -> Operations.login.Output {
return .seeOther(.init(headers: .init(location: "https://apple.com")))
}
}
@main struct LoginServer {
static func main() async throws {
let app = Vapor.Application()
let transport = VaporTransport(routesBuilder: app)
let handler = Handler()
try handler.registerHandlers(on: transport, middlewares: [
UnescapeLocationHeaderMiddleware()
])
try await app.execute()
}
}
struct UnescapeLocationHeaderMiddleware: ServerMiddleware {
func intercept(
_ request: HTTPRequest,
body: HTTPBody?,
metadata: ServerRequestMetadata,
operationID: String,
next: (HTTPRequest, HTTPBody?, ServerRequestMetadata) async throws -> (HTTPResponse, HTTPBody?)
) async throws -> (HTTPResponse, HTTPBody?) {
var (response, responseBody) = try await next(request, body, metadata)
guard let location = response.headerFields[.location] else {
return (response, responseBody)
}
response.headerFields[.location] = location.removingPercentEncoding
return (response, responseBody)
}
}
Now, thanks for reporting this. It's a bit troubling, and I suspect we'll need some way to make this more compatible with clients that don't percent-decode header fields.
If you don't mind, I'll repurpose this issue to track improving Swift OpenAPI Generator this way and rename it.
from swift-openapi-generator.
Related Issues (20)
- Generated enums should conform to `CaseIterable` HOT 7
- Is it possible to use component refs in paths that accept multiple content types? HOT 8
- Multipart content not properly generated? HOT 11
- A way to group features or services to allow middleware to be applied to groups HOT 4
- Manual invocation of the generator and SPM warnings HOT 5
- Null property type with quotes not generated HOT 14
- Support for XML request body and response body HOT 7
- Support schemas.type: string, format: uri generates URL property not String HOT 3
- How to support OAuth2 Password flows? HOT 3
- allOf plus properties HOT 2
- OpenAPI shared components HOT 4
- bug/regression: latest yams results in incomplete generation of types HOT 10
- Logging and HTTPBody HOT 3
- Merging oneOf with many compatible enums of a single value HOT 10
- anyOf encoder does not include discriminator's `parameterName` leading to incorrect encoding HOT 2
- Is there a workaround to deal with slow compilation times for a very large openapi file? HOT 3
- Empty arrays are omitted from query params HOT 5
- Support for `multipart/mixed`? HOT 1
- When a delete path do not have responses content an error generated HOT 2
- Add ability to attach protocols to generated models HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from swift-openapi-generator.