-
Notifications
You must be signed in to change notification settings - Fork 696
New Services Quick Start
Chris Martinez edited this page Sep 14, 2016
·
12 revisions
When a service author creates new services that consider API versioning upfront, then the configuration and setup is very straightforward. The following examples provide a quick start setup for the respective platforms with default configurations.
API versions can be expressed with .NET attributes or by configured conventions. These examples all use .NET attributes. If you're interested in using conventions instead, please review the API version conventions topic.
public static class WebApiConfig
{
public static void Configuration( HttpConfiguration configuration )
{
configuration.AddApiVersioning();
// remaining configuration omitted for brevity
}
}
[ApiVersion( "1.0" )]
[RoutePrefix( "people" )]
public class PeopleController : ApiController
{
[Route]
public IHttpActionRoute Get() => Ok( new[] { new Person() } );
}
public static class WebApiConfig
{
public static void Configuration( HttpConfiguration configuration )
{
configuration.AddApiVersioning();
var modelBuilder = new VersionedODataModelBuilder( configuration )
{
DefaultModelConfiguration = ( builder, apiVersion ) =>
{
builder.EntitySet<Person>( "People" );
}
};
var models = modelBuilder.GetEdmModels();
configuration.MapVersionedODataRoutes( "odata", null, models );
// remaining configuration omitted for brevity
}
}
[ApiVersion( "1.0" )]
[ODataRoutePrefix( "People" )]
public class PeopleController : ODataController
{
[ODataRoute]
public IHttpActionRoute Get() => Ok( new[] { new Person() } );
}
public class Startup
{
public void ConfigureServices( IServiceCollection services )
{
services.AddMvc();
services.AddApiVersioning();
// remaining configuration omitted for brevity
}
}
[ApiVersion( "1.0" )]
[Route( "[controller]" )]
public class PeopleController : Controller
{
[HttpGet]
public IActionRoute Get() => Ok( new[] { new Person() } );
}
- 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