Add Builder to simplify openapi document object construction #673

Activity

1. darrelmiller commented on Jan 23, 2022

   

   Darrel (darrelmiller)

   on Jan 23, 2022

   Member

   More actions

   Agreed, building it is clunky. Would you mind starting a discussion thread on ways that we could improve construction?

   🎉React with 🎉1Reacted by gparmigiani
2. jkone27 commented on Jan 24, 2022

   

   gparmigiani (jkone27)

   on Jan 24, 2022

   Last edited by jkone27

   Author

   More actions

   I very nice project i saw in the F# space is this one (it uses F# Computation Expressions CEs for the builder pattern), but probably with extension methods something much similar can be obtained.. (or maybe also the F# part could be included in the "official one" for the F# api)

   https://github.com/akhansari/FSharp.OpenApi

   let document =
       apiDocument {
           info (apiInfo {
               version "1.0.0"
               title "Swagger Petstore (Simple)"
           })
           servers [
               apiServer {
                   url "http://petstore.swagger.io/api"
               }
           ]
           paths [
               "/pets", apiPathItem {
                   operations [
                       OperationType.Get, apiOperation {
                           description "Returns all pets from the system that the user has access to"
                           responses [
                               HttpStatusCode.OK, apiResponse {
                                   description "OK"
                               }
                           ]
                       }
                   ]
               }
           ]
       }
   
   let outputString =
       document.Serialize (OpenApiSpecVersion.OpenApi3_0, OpenApiFormat.Json)

   i guess the C# counterpart would be like

   var document = 
       OpenApi.Builder()
             .WithInfo(....)
             .WithServers(...)
             .WithPaths(...)
             .Build();
             
     var openApiJsonV3String = document.Serialize (OpenApiSpecVersion.OpenApi3_0, OpenApiFormat.Json);
             
3. Darrel (darrelmiller)

   added

   type:enhancementEnhancement request targeting an existing experienceEnhancement request targeting an existing experience

   on Mar 1, 2022
4. Darrel (darrelmiller)

   added this to the Backlog milestone on Mar 1, 2022
5. captainsafia commented on Sep 26, 2022

   

   Safia Abdalla (captainsafia)

   on Sep 26, 2022

   Contributor

   More actions

   I came across this issue while drafting a proposal for a new API in ASP.NET Core that builds on top of Microsoft.OpenAPI (see dotnet/aspnetcore#44192).

   IMO, it would be really neat to have a builder-style pattern for an OpenAPI document.
6. vivian (adhiambovivian)

   added

   status:needs-discussionAn issue that requires more discussion internally before resolvingAn issue that requires more discussion internally before resolving

   on Apr 3, 2023
7. Darrel (darrelmiller)

   added

   help wanted

   and removed

   status:needs-discussionAn issue that requires more discussion internally before resolvingAn issue that requires more discussion internally before resolving

   on Apr 29, 2025
8. darrelmiller commented on Apr 29, 2025

   

   Darrel (darrelmiller)

   on Apr 29, 2025

   Member

   More actions

   If someone wants to prototype a builder object, they are welcome to create a PR.