Extend your OAS generation to include AWS Api Gateway annotations
NEW FEATURES!
- Emit OPTIONS mock methods for all paths to facilitate CORS handshaking
- Autogenerate request mapping for PATH parameters
Getting started
Setting document centric configuration:
services.AddSwaggerGen(c =>
{
c.AddXAmazonApiGatewayAnnotations
(
options =>
{
options
.WithKeySource(ApiKeySource.Header)
.WithRequestValidators
(
rv => rv.RequestValidators = new []
{
new RequestValidator("basic")
{
ValidateRequestParameters = true,
ValidateRequestBody = true
},
new RequestValidator("params-only")
{
ValidateRequestBody = false,
ValidateRequestParameters = true
}
}
)
.WithRequestValidator(rvo => rvo.RequestValidator = "basic");
}
);Setting default values for actions:
c.AddXAmazonApiGatewayOperationAnnotations
(
op =>
{
op.WithIntegration
(
intOpt =>
{
intOpt.Type = IntegrationType.http_proxy;
intOpt.BaseUri = "https://your.domain.com";
}
);
}
);Setting default values for controllers:
[ApiController]
[Route("[controller]")]
[XAmazonApiGatewayIntegration(PassthroughBehavior = PassthroughBehavior.WHEN_NO_MATCH)]
[XAmazonApiGatewayRequestValidator(RequestValidator = "params-only")]
public class WeatherForecastController : ControllerBase
{Setting values for actions:
[HttpGet]
[XAmazonApiGatewayIntegration(ConnectionType = ConnectionType.INTERNET)]
[XAmazonApiGatewayRequestValidator(RequestValidator = "params-only")]
public IEnumerable<WeatherForecast> Get()
{Configuring your endpoint:
app
.UseSwagger
(
c =>
{
c.PreSerializeFilters.Add((swagger, httpReq) =>
{
swagger.Servers = new List<OpenApiServer>
{
new OpenApiServer
{
Url = $"https://www.yourcustomdomain.com"
}
.AsRegionalEndpoint()
//.AsEdgeEndpoint("yourcustomdomain.com")
//.AsPrivateEndpoint("vpcid1", "vpcid2", "vpcid3")
//.AsRegionalEndpoint("yourcustomdomain.com")
};
});