Stack Overflow
Stack Overflow

Questions tagged [swashbuckle]

Swashbuckle is an open source framework which adds Swagger and Swagger-ui to ASP.NET Web API projects.

Swashbuckle combines ApiExplorer, Swagger and Swagger-ui to provide a rich discovery, documentation and playground experience to your ASP.NET Web API consumers.

Core features:

  • Auto-generated Swagger 2.0
  • Seamless integration of swagger-ui
  • Reflection-based Schema generation for describing API types
  • Extensibility hooks for customizing the generated Swagger doc
  • Extensibility hooks for customizing the swagger-ui
  • Out-of-the-box support for leveraging Xml comments
  • Support for describing ApiKey, Basic Auth and OAuth2 schemes ... including UI support for the Implicit OAuth2 flow

The Swashbuckle tag should be used for questions about:

  • Configuring Swashbuckle
  • Extending Swashbuckle with the interfaces ISchemaFilter, IOperationFilter and IDocumentFilter
  • Customizing the embedded Swagger-UI

Questions specifically addressing Swagger or Swagger-UI should not be tagged with the Swashbuckle tag.

Source code: https://github.com/domaindrivendev/Swashbuckle

1366 questions
0
votes
1 answer

How to hide model properties in specific operations?

I got some issue with Swashbuckle. We have a model Student like this: public class Student { public int Id { get; set; } public string Name { get; set; } public string Class { get; set; } public StudentStatus Status { get; set;…
ChainList
  • 1,198
  • 7
  • 28
0
votes
1 answer

Swagger 5.2.3 SupportedSubmitMethods removed?

I noticed that from version 5.0 and above the SupportedSubmitMethods option has been removed and now all HTTP verbs are implicitly supported, according to this part of the Swashbuckle documentation. Is there a way to choose which HTTP verbs will…
iliyan tanev
  • 377
  • 2
  • 15
0
votes
1 answer

Swagger doc stopped generating using swashbuckle

I have been developing a WebApi2 REST API with swagger docs (using swashbuckle) for a while now however in my local sandbox version I cannot get to the SwaggerUI, nor the swagger xml via a GET request. I have compared swagger setup between my code…
Mark Ruse
  • 387
  • 1
  • 4
  • 12
0
votes
0 answers

Swashbuckle Route Issues

Having a few issues with Swashbuckle and mostly routing. So I am working with an API that has controller specific routes defined for some and a generic default route for all others. Both have defaults included in the route specification. Specific…
Reosoul
  • 197
  • 9
0
votes
1 answer

Swashbuckle configuration error

I'm trying to add Swashbuckle into my ASP.NET MVC WebAPI project. I've started with an empty MVC project template in Visual Studio 2013. Later I added the required files/packages etc. But somehow I can't manage to integrate Swashbuckle into it.…
Arnab Das
  • 3,548
  • 8
  • 31
  • 43
0
votes
1 answer

No error thrown by AutoRest Generated API Client Azure API Service

We use Swashbuckle to generate swagger from our api services and then generate an API client using the ADD Azure API Client function in Visual Studio. This client works perfectly except in the case that the Server runs into a problem and throws an…
CrazyBernie
  • 174
  • 1
  • 8
0
votes
0 answers

Can't Open the Swagger page,

After I add swashbuckle 5.2.2 pakage. I can't open the /Swagger Page? I've add the below code : protected static string GetXmlCommentsPath() { return System.String.Format(@"{0}\bin\UnitTestingWebAPI.API.Core.XML",…
huoxudong125
  • 1,966
  • 2
  • 26
  • 42
0
votes
1 answer

How do I catch the beforeSend event for any ajax call?

Is it possible to catch the $.ajax beforeSend event for ALL ajax calls on the page regardless of where it's initiated? Specifically I'm using Swagger UI / Swashbuckle and cannot modify the JS code on the page directly, but can use the…
Ed Williams
  • 167
  • 2
  • 12
0
votes
1 answer

Web Api documentation with swashbuckle

We are currently trying to start writing WebApi services for our products switching from traditional WCF SOAP based services. The challenge we have got is how to provide the api documentation. I came across the SwaggerUi/swash buckle. One…
Nasir
  • 59
  • 11
0
votes
1 answer

Swashbuckle shows no method after migration to VS 2015

I have ASP.NET WebApi configured with Swashbuckle to show swagger ui. I run it from within VS in IIS Express. The solution was in VS 2013 and it worked fine. After migration to VS 2015 the swagger shows no methods. There's no error, just empty…
eXavier
  • 4,821
  • 4
  • 35
  • 57
0
votes
1 answer

show dateTime dataType in DataContract model on swagger UI via swashbuckle webapi 2 C#

I am using a datacontract for the model and the datetime datamember is working properly, however swagger ui is showing the datatype as string instead of dateTime. datamember example: [DataMember(EmitDefaultValue = false, Order = 6),…
mdev
  • 1
  • 1
  • 2
0
votes
2 answers

Swagger 2.0 have strings in models appear as ""

I'm upgrading to swagger 2.0 and in the UI of my models I want strings to appear as "". Right now the model schema looks like { "Name": "string", "Id": "string", "Year": 0 } and I want it to look like { "Name": "", "Id": "", "Year":…
nastassiar
  • 1,545
  • 2
  • 24
  • 43
0
votes
1 answer

Swagger/ Swashbuckle nested responses not showing up correctly

I'm trying to upgrade from Swashbuckle 4 to 5 and swagger 1.2 to 2. The issue I'm having is the response schema isn't showing up correctly if the response has another object within it. While using Swagger 1.2 my Model Schema looked like this: { …
nastassiar
  • 1,545
  • 2
  • 24
  • 43
0
votes
1 answer

Upgrading to swagger 2.0 getting Operation/DataType type

I'm trying to upgrade Swagger from 1.2 to 2.0 and I'm having issues getting the Operation type. In 1.2 the Operation Object included the Data Type Fields in order to describe the return value of the operation. But it doesn't look like this is the…
nastassiar
  • 1,545
  • 2
  • 24
  • 43
-1
votes
1 answer

Swagger: how to use the generated json files?

I've been provided with the json files generated by swashbuckle for a rest api I should be consuming and I was wondering if there are tools that can take those files as input and allow an easier navigation of exposes methods, request payloads,…
whatever
  • 2,492
  • 6
  • 30
  • 42
1 2 3
…
90
91