-
Notifications
You must be signed in to change notification settings - Fork 707
Custom API Version Format
Chris Martinez edited this page Jan 9, 2023
·
1 revision
It is now possible to extend or change the provided API version format, but that capability comes with several rules:
- You must extend
ApiVersion
- You must override:
GetHashCode
CompareTo
ToString(string,IFormatProvider)
- You must implement
IApiVersionParser
- It may be possible to extend
ApiVersionParser
depending on your requirements
- It may be possible to extend
You will likely need to extend ApiVersionFormatProvider
or implement a custom IFormatProvider
. Although not strictly required, you may want to implement operator overloads for your custom type to retain functional parity with ApiVersion
. The custom parser will need to be passed to components that accept IApiVersionParser
and/or replace the default implementation registered for dependency injection.
You should consider the impact that a custom API version may have on clients. Your custom format and parsing logic may need to be distributed to them for to use.
- Home
- Quick Starts
- Version Format
- Version Discovery
- Version Policies
- How to Version Your Service
- API Versioning with OData
- Configuring Your Application
- Error Responses
- API Documentation
- Extensions and Customizations
- Known Limitations
- FAQ
- Examples