Время идет, и теперь Swashbuckle работает с vNext (для меня beta8, возможно, и другие версии) - спасибо команде и участникам!
В project.json добавьте пакет:
"Swashbuckle": "6.0.0-*",
В startup.cs в ConfigureServices ():
services.AddSwaggerGen();
services.ConfigureSwaggerDocument(options =>
{
options.SingleApiVersion(new Info
{
Version = "v1",
Title = "My Super API",
Description = "A Super API using Swagger and Swashbuckle",
TermsOfService = ""
});
});
services.ConfigureSwaggerSchema(options =>{
options.DescribeAllEnumsAsStrings = true;
});
В startup.cs в Configure ():
app.UseSwaggerGen();
app.UseSwaggerUi();
Теперь у вас есть доступ к документации API - http://domain:port/swagger/ui/index.html
Получите доступ к вашему определению Swagger - http://domain:port/swagger/v1/swagger.json
Затем, предполагая, что у вас есть хотя бы одна интернет-среда dev / uat / staging / prod, возьмите URL-адрес определения, затем выполните File-> Import URI в http://editor.swagger.io/ - теперь у вас есть code-gen примерно для 20 клиентов :)
Вы также можете настроить свой собственный сервер генерации кода, если хотите (https://github.com/swagger-api/swagger-codegen), однако я использовал существующий онлайн-генератор. Онлайн-редактор также имеет полные определения модели и отношений, по крайней мере, в моем случае, когда я полностью определил свою модель с помощью EF7 (я знаю, ick ... но это намного лучше, чем ‹= EF6, а ServiceStack пока не поддерживает CoreCLR) . В зависимости от размера вашего проекта это может сэкономить вам от нескольких часов до нескольких недель рабочего документирования, плюс он динамически обновляется по мере того, как вы пишете больше. И вы также можете использовать его для тестирования своих конечных точек, но я по-прежнему предпочитаю PostMan.
Полный пример проекта на https://github.com/mrsheepuk/ASPNETSelfCreatedTokenAuthExample/tree/beta8
Большие успехи MrSheepUK
HTH
person
Ben E G
schedule
22.11.2015
