GodelTech.Microservices.Swagger 8.1.0

GodelTech.Microservices.Swagger

Overview

GodelTech.Microservices.Swagger project provides initializer which configures Swagger endpoinds and Swagger UI. Default configuration looks as follows:

• Swagger UI can be found at http://yourwebsite.com/swagger/index.html
• Swagger document can be found at http://yourwebsite/swagger/v1/swagger.json

Default behavior can be overriden by changing values of intializer's Options property or by deriving your customer initializer from SwaggerInitializer.

Quick Start

Simplest usage of swagger initializer may look as follows:

    public sealed class Startup : MicroserviceStartup
    {
        public Startup(IConfiguration configuration)
            : base(configuration)
        {

        }

        protected override IEnumerable<IMicroserviceInitializer> CreateInitializers()
        {
            ...
            yield return new SwaggerInitializer(
                options =>
                {
                    options.DocumentTitle = "Demo API";
                    options.DocumentVersion = "v1";
                    options.AuthorizationUrl = new Uri("http://authorize.url");
                    options.TokenUrl = new Uri("http://token.url");
                    options.Scopes = new Dictionary<string, string>
                    {
                        { "Scope1", "Scope description" }
                    };
                }
            );
            ...
        }
    }

This code snippet adds swagger endpoints to your application and exposes document for once version of your API.

Configuration Options

Easiest way to configure initializer is to use properties of SwaggerInitializerOptions class. The following table contains list of available settings:

Full control over SwaggerInitializer can be obtained by defined child class. The following protected methods are avaible:

Links

Current project is Swagger extension of Microservice Framework. You can find references to all available projects in core project of framework GodelTech.Microservices.Core. Extension is based on Swashbuckle.AspNetCore project.