Giter Site home page Giter Site logo

Comments (3)

msmolka avatar msmolka commented on June 11, 2024 1

Probably not directly. I’ve seen example with WithOpenApi, but I know I cannot use it here. That’s why I’m asking. But I think it is not right place.

from aspnet-api-versioning.

commonsensesoftware avatar commonsensesoftware commented on June 11, 2024

Is this specific to API Versioning? This appears to be general in nature with respect to using OpenAPI in Minimal APIs. I recommend starting with the OpenAPI Support in Minimal APIs. Pairing up XML Comments is a specific feature of Swashbuckle. I'm not sure if it supports that in Minimal APIs. If you have specific questions about API Versioning withing these contexts, I'm happy to answer them.

from aspnet-api-versioning.

commonsensesoftware avatar commonsensesoftware commented on June 11, 2024

WithOpenAPI just attaches the OpenApiOperation as metadata. You should be able to configure the information directly or with one of the many specialized extension method (though I'm not sure there is one for this specific case).

As it relates to API Versioning, you can use all of the provided APIs, but you need to be careful if interleave versions and you want OpenAPI support on a Minimal API. The current design only support attaching a single OpenApiOperation, which can produce the wrong results. I've gone through the scenario with the ASP.NET team, but it doesn't look like we will see that enhancement in .NET 8. The easiest way to avoid that problem is to have a single Minimal API (action method) defined per route+version combination (e.g. do not interleave). Everything else should behave normally. If you're hitting a wall here, I can try to help out.

In terms of XML Comments, API Versioning doesn't get use them or involve them in any way.

from aspnet-api-versioning.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.