Swagger

OpenAPI

Intended Solutions for Intentional Limitations of Strongly Typed OpenAPI Client Generators

1 Feb 2024 by Zijian

Use the codes generated by OpenApiClientGen in real world applications

Generate Typed Forms of Angular Reactive Forms from Swagger / OpenAPI definitions

10 Jan 2024 by Zijian

Construct Angular Reactive Forms of client data models through generated Angular TypeScript codes

Generate Typed FormGroup of Angular Reactive Forms with ASP.NET Core Web API

9 Jan 2024 by Zijian

Construct Angular Reactive Forms of client data models through generated codes

How to change datetime format in swagger in .NET core

3 Jan 2019 by RickZeeland

I had a similar problem with the JSON serializer, I could solve it by using: var myDate = new DateTime(2019, 1, 1, 12, 0, 0, DateTimeKind.Local); If you don't want the trailing Timezone information, use: var myDate = new DateTime(2019, 1, 1, 12, 0, 0, DateTimeKind.Unspecified); Also see:...

Built in API Documentation Support Following Open API Specification V3 for Azure Functions Developed using .NET 6

OpenApiClientGen to Generate Strongly Typed Client API Codes Based on Open API Definitions

3 Jul 2020 by Zijian

6 Aug 2022 by Sauradipta Chaudhury

Easiest way to implement Swagger based OAS 3 documentation support for your Azure Functions built using .NET 6

How to change datetime format in swagger in .NET core

3 Jan 2019 by chaks nag

By default date time field is displaying UTC time zone, how can it be changed to current time zone in swagger in .Net core. What I have tried: I have not done any code changes except using swashbuckle.AspNetcore 4.0.1 nuget package. when trying to test api, in the post request the start date...

How to fix the failed to parse JSON/YAML response

7 Jan 2019 by AshishvermaMCA

I'm getting issue when i run api with swagger ui, error are 'failed to parse JSON/YAML response' on deployment server but in local environment its running fine. So, i did't get exact error on browser as well. Can any one help me quickly. What I have tried: In local environment its working fine...

MVC

Unable to get record while using the double backslash in swagger using get function with parameters

22 Aug 2019 by User 14447995

I've two parameters like Register No. and UserName. I Entered Register No. Like "###$$$$%%%%" and UserName Like "TESTPC\TEMP" than result is successful but no record shown. Instead of above if I Entered. Like UserName. I Entered Register No. Like "###$$$$%%%%" and UserName Like "TESTPC\TEMP"...

Unable to get record while using the double backslash in swagger using get function with parameters

22 Aug 2019 by BillWoodruff

Use Swashbuckle.OData to generate Swagger: [^] also see: [^] Why not try Swagger support: [^] Are you sure Swagger supports OData: see [^] and [^]

Use the filter query for range but without any column name or primary key

1 Oct 2019 by OriginalGriff

Quote: I want to filter the record ... without primary key or without using any column name. You do realize that that request is just nonsense, don't you? You have a set of values in a table that you which to filter down to: in your case "Record_1" to "Record_100" which means that you have to...

Use the filter query for range but without any column name or primary key

1 Oct 2019 by Maciej Los

If i understand you well, you're talking about data pagination... Check this out: Paging with ASP.NET Web API OData – Youssef M's Blog[^]

How do I disable swashbuckle swagger UI in production in ASP.NET web api2?

19 Jun 2022 by istudent

I using swashbuckle v 5.6.0 for api documentation and ui for test in asp.net web api2. I do not want give ability for the user to post data from swagger ui in production. How do I disable it? What I have tried: GlobalConfiguration.Configuration .EnableSwagger(c => ...

ASP.NET5

WebAPI2

How do I disable swashbuckle swagger UI in production in ASP.NET web api2?

7 Jan 2020 by MadMyche

Have you looked into there GIT repository and read this issue? Disabling swagger ui · Issue #301 · domaindrivendev/Swashbuckle · GitHub[^]

ASP.NET5

WebAPI2

Get error 401 authorization with swagger but works properly in postman (dot net core)

7 Dec 2022 by SajjadZare

I add swagger to my project and use authorization. It works properly with Postman but when want to use with Swagger get 401 Undocumented What I have tried: public void ConfigureServices(IServiceCollection services) { ... ...

Get error 401 authorization with swagger but works properly in postman (dot net core)

30 Aug 2020 by Sandeep Mewara

I don't see where are you setting the bearer token in your code. You define there would be one though. Would suggest you to compare the network call when of your request when sent through swagger and via postman and you should observe that...

Unable to customize swagger UI in .NET framework

2 Nov 2020 by DevCodeproject1

Using Swagger (Swashbackle Package) in the .NET framework for WEB API specifications. The Swagger UI is completely different from the .NET Core's swagger UI. Is it possible to implement the Same theme in the Swagger, If yes, Could you suggest a...

Unable to customize swagger UI in .NET framework

15 Sep 2020 by Sandeep Mewara

Try this: How to customize Swagger UI in ASP.NET Web API – Umamaheswaran[^] Seems he has few customized templates: GitHub - ostranme/swagger-ui-themes: A collection of css themes to spice up your Swagger docs[^] Another reference: Implementing...

Swagger: describe parameter

5 Dec 2020 by csrss

So lets say I have an endpoint like this: public async Task Test([FromBody]string jsonData) How can I provide a json schema for jsonData parameter? Is it possible? I know that if I have a DTO then swagger scaffolds properties...

JSON

Can I use remarks on a property in swagger

28 Feb 2021 by rtksmithjoton123

I want to add the on a property in a model. public class MyModel { /// summary /// /// example: ... /// public int id { get; set; } } The...

Get error 401 authorization with swagger but works properly in postman (dot net core)

15 Sep 2021 by Member 13251389

If you are adding token in "Available authorizations" Pop up/Model. Please make sure you have added a word "Bearer" with space followed by token. This was my issue.

Creating an Insomnia-First Swagger Page

24 Sep 2021 by Jason Sultana

Create an Insomnia-First swagger page, so your API can easily be consumed by Insomnia, all in one click

REST

JSON

Swaggerui doesn't show pojo class in models area

17 Nov 2021 by Member 15435322

This is my swagger configuration class: package com.example.ecourtcustinfolast.config; import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import...

Ho do I read an image using swaguer

2 Jun 2022 by Luis M. Rojas

I am new using web apoi and swagger. When i am testing de web api using swagger, i have to fillout the image field: How can i do that? because i can type: name, firstname, etc, but the image i do not know. Thanks What I have tried: I do not...

web

Ho do I read an image using swaguer

2 Jun 2022 by Graeme_Grant

Google is your friend. I just did a Google search using c# swagger image[^] and immediately found: asp.net core - How to display multiple images using swagger api (controller) in C# & .netcore 3.1 using SQL database server? - Stack Overflow[^]

web

JWT bearer token not authorizing

9 Jul 2022 by Member 8583441

I am designing an api for Educational field. So, I have created WebAPI with authentication mode windows in .Net6. I am having two controllers namely, AuthController and TeacherController. AuthController for authorizing the user and to create JWT...

Swagger ui is not showing HTTP 407 from a rest api

19 Oct 2022 by Virendra S from Bangalore, Karnataka

I am returning a 407 http status code from one endpoint, in postman I can see the 407Proxy Authentication Required response, but in my api swaggerui instead of 407 it is showing as Code Details Undocumented Failed to fetch. To cross check...

Swagger ui is not showing HTTP 407 from a rest api

19 Oct 2022 by Richard Deeming

Swagger does not attempt to analyze your code to determine every possible response code. You need to tell it which response codes your action can return: Get started with Swashbuckle and ASP.NET Core | Microsoft Learn[^] Eg: [HttpGet]...

Get error 401 authorization with swagger but works properly in postman (dot net core)

7 Dec 2022 by toumir

have the same problem resolved : just add bearer word before jwt : brearer thaus all :)

Api with swagger for team in laravel

27 Dec 2022 by zhrsh

How can I reduce api codes with swagger above each method in Laravel? What I have tried: I am looking for a solution or introduction of a free and alternative program that makes it easier for the mobile team members to test and ship api with...

Swashbuckle UI - header field is not set in request

14 Feb 2023 by stdout

Dear community, I try to create an web api endpoint that returns an image in a format that can be defined in the 'Accept-Header' field of the request. I'm using Swashbuckle NugGet Package (Swashbuckle.AspNetCore, Version 6.5.0) and the UI shows...

Why does my generated swagger.json file not include the filtered endpoints

5 Apr 2023 by EdDenLau

Hello, I need help using Swagger in an Asp.Net Core 6.0 API and filtering endpoints. The goal is that only the endpoints that should be available for a specific end customer are displayed on the Swagger website. And the generated swagger.json...

endpoint

How to automatically generate an openapi documentation from a jsonresult response?

7 Jan 2024 by GinCanhViet

Swashbuckle can automatically generates API documentation based on code (with details return model) [HttpGet] public ActionResult> GetStudents() { return CollegeRepository.Students; } https://i.stack.imgur.com/hHGze.png It...

ASP.NET-Core

OpenAPI

Can not find the apis in GRCP project! ! !

15 Feb 2024 by OriginalGriff

Don't post this under Quick Answers - if you got the code from an article, then there is a "Add a Comment or Question" button at the bottom of that article, which causes an email to be sent to the author. They are then alerted that you wish to...

IoT Home Assistant API for Raspberry Pi

29 Oct 2018 by Jose Motta

Build an embryo API that improves interaction between Home Assistant and Docker containers

Creating a RESTful API with Automatic Documentation on Azure App Service

11 Jun 2021 by Hugo G Fernandez R

In this article, I will explain and show step by step how to implement through the swashbuckle library a good and useful documentation for your RESTful APIs created under the ASP.

WebApiClientGen vs Swashbuckle plus NSwag

8 May 2020 by Zijian

Compare what is supported in WebApiClientGen and NSwagStudio

Fusion Development for Sales Apps Part 3: Working with Form Data

12 Apr 2022 by Lontia Nkhuwa

In this article we create a custom connector, call the API, and create a reservation button.

How do I disable swashbuckle swagger UI in production in ASP.NET web api2?

19 Jun 2022 by Gerardo Gamo

If you are using NET framework (any version capable of having swagger) in you web.config, 1. create a new key called IsSwaggerEnabled and set it to true ...

ASP.NET5

WebAPI2

Can not find the apis in GRCP project! ! !

15 Feb 2024 by sina heidari

I start to work on the GRCP project (client). when I run the project I can open the swagger and there are two APIs there. I searched very much to find out where these two APIs are!!! couldn't find!!!! This project is run on docker. The...

How to fix the failed to parse JSON/YAML response

7 Jan 2019 by algem mojedo

Hi, I am not sure if could help. IN IE... Change Compatibility View Settings CheckBox 1. Display Intranet sites in Compatibility View 2. Use Microsoft compatibility lists

MVC

Use the filter query for range but without any column name or primary key

1 Oct 2019 by User 14447995

hello, I want to filter the record from Record_1 To Record_100 or whatever the range we want but without primary key or without using any column name. I'm using odata C#. Is it possible and how? Thanks What I have tried: I have tried but with primary key and i want without primary key. what...

How to expose endpoints API in C# using webservices?

13 Oct 2020 by gcogco10

Hi Team I am struggling to expose 3 endpoints, because i dont know if need to implement them on the controller. These 3 endpoints must Add a coin. Get the total amount of coins. Reset the coins. What I have tried: //Interface using...

Get error 401 authorization with swagger but works properly in postman (dot net core)

2 Dec 2020 by And68rei

Did you find a solution? I have the same problem trying to implement windows authentication.

How to autogenerate test cases from openapi v3 description using spring boot/java

24 Nov 2022 by Pranav Arya

I want to create a tool that will accept the “OpenAPI v3 definition” document as input. Based on that, it will generate basic test cases to validate/check the API behaviour using Java/Spring Boot. Can someone please help with that or give me some...

Java

springboot