[feature request] make APIs sorted in swagger.json

[sakrist]

Hi,
thanks for the awesome package!

I was trying to look into the code and figure out where the encoding is happening but did not figure out the precise place.
Then I found SwiftOpenAPI is doing things but still not sure. It looks like it has an ordered dictionary and the encoder has sortedKeys as outputFormatting in SpecificationExtendable. Still does keep the order.
Am I looking at the right place?

[dankinsoid]

Hello @sakrist!
Usually, swagger.json is returned by a route like this:

routes.get("Swagger", "swagger.json") { req in
    req.application.routes.openAPI(

But routes.openAPI returns just an encodable OpenAPIObject struct, so Vapor converts it to a JSON file.
I do use OrderedDictionary under the hood for consistent results, but if you want output with sorted keys, you can configure Vapor globally:

let encoder = JSONEncoder()
encoder.outputFormatting = .sortedKeys
ContentConfiguration.global.use(encoder: encoder, for: .json)

Or you can encode the OpenAPIObject directly in the route with custom encoder and return Data.

The point of SpecificationExtendable is to provide dynamic properties for Codable structs, because many OpenAPI types support dynamic fields prefixed with "x-".