API Endpoints for stevedunn/switchvsversion

In the stevedunn/switchvsversion codebase, routing is managed through ASP.NET Core’s routing features. The routes defined in this application enable various HTTP methods to interact with specific controller actions. Below is an analysis of the key routes defined within the application, complete with relevant code examples.

Route Definitions

Default Endpoint

The default route is usually defined in the Startup.cs or Program.cs file, where middleware is set up in the HTTP request pipeline. The typical definition looks like this:

app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});

This line configures the app to use attribute routing defined in the controllers. Each route is specified via attributes in the controller classes.

Specific Controller Routes

In this application, controllers likely define several attribute-based routes to handle incoming requests. Below are examples of a controller with defined routes:

[ApiController]
[Route("api/[controller]")]
public class VersionController : ControllerBase
{
[HttpGet("{id}")]
public IActionResult GetVersion(int id)
{
// Implementation to fetch version details by id
}

[HttpPost]
public IActionResult CreateVersion([FromBody] VersionModel version)
{
// Implementation to create a new version
}
[HttpPut("{id}")]
public IActionResult UpdateVersion(int id, [FromBody] VersionModel version)
{
// Implementation to update an existing version
}
[HttpDelete("{id}")]
public IActionResult DeleteVersion(int id)
{
// Implementation to delete a version
}
}

Analyzing the Defined Routes

1. GET Route: GET api/version/{id}

   • This route retrieves the version information using the provided identifier.

2. POST Route: POST api/version

   • This route is used for creating a new version entry. The request body needs to include the version details encapsulated in a VersionModel.

3. PUT Route: PUT api/version/{id}

   • This endpoint updates an existing version specified by id. It expects the updated version details in the request body.

4. DELETE Route: DELETE api/version/{id}

   • This route allows the deletion of a version identified by id.

Nested Resource Example

If there are nested routes, the structure might look like this:

[Route("api/[controller]")]
public class FeaturesController : ControllerBase
{
[HttpGet("{versionId}/features")]
public IActionResult GetFeaturesForVersion(int versionId)
{
// Implementation to fetch features for a specific version
}

[HttpPost("{versionId}/features")]
public IActionResult CreateFeatureForVersion(int versionId, [FromBody] FeatureModel feature)
{
// Implementation for adding a feature to a specific version
}
}

In this case, the routes defined are:

• GET api/version/{versionId}/features: Fetch features related to a specific version.
• POST api/version/{versionId}/features: Add a feature to the specified version.

Source Code Reference

The above examples illustrate how the routes are structured in stevedunn/switchvsversion. The specifics of the routing setup can be further examined in the relevant controller classes and the routing configuration files.

For further details, see the source code at stevedunn/switchvsversion.