Swagger:如何获取格式化的json字符串
Swagger是一个开源的API框架工具，用于设计、构建、文档化和测试RESTful风格的Web服务。通过Swagger，开发人员可以方便地定义API的结构和操作，并自动生成可交互的API文档。要获取格式化的JSON字符串，可以按照以下步骤进行操作：
- 定义API：首先，使用Swagger提供的注解和规范，编写API的定义文件。这个文件可以是YAML或JSON格式的。在文件中定义API的路径、参数、请求方法、响应等信息。
- 生成API文档：使用Swagger提供的工具，将API定义文件转换为可视化的API文档。这个文档将包含API的详细信息，包括请求示例、参数说明、响应格式等。
- 浏览API文档：打开生成的API文档，在文档中找到需要获取格式化JSON字符串的API接口。
- 发送请求：在API文档中，找到相应的API接口，并根据接口的要求填写参数。通常，API文档会提供一个交互式的界面，可以直接在文档中输入参数并发送请求。
- 查看响应：发送请求后，API文档将显示响应结果。如果响应是JSON格式的，Swagger通常会自动对其进行格式化，以便更易于阅读。
总结起来，要获取格式化的JSON字符串，你可以使用Swagger来定义API并生成API文档，然后通过API文档提供的交互式界面发送请求，并查看响应结果中的JSON字符串。这样可以方便地获取格式化的JSON数据。
腾讯云相关产品和产品介绍链接地址：
- 产品名称：API网关
- 产品介绍链接地址：https://cloud.tencent.com/product/apigateway
- 产品名称：Serverless Cloud Function
- 产品介绍链接地址：https://cloud.tencent.com/product/scf
- 产品名称：云函数
- 产品介绍链接地址：https://cloud.tencent.com/product/tcf
相关·内容
如果我们打开swagger编辑器网站https://editor.swagger.io/，它会有一个默认的swagger示例。前几行是 swagger: "2.0"
info:
description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/)
浏览 53提问于2021-08-13得票数 1
在Startup.cs中配置以下代码
变量。
private const string SwaggerDocumentVersionName = "v1";
private static string SwaggerDocumentServiceName => $"Users API({SwaggerDocumentVersionName})";
ConfigureServices方法。
services.AddSwaggerGen(c =>
{
c.SwaggerDoc(
SwaggerDocumentVersionName
浏览 9提问于2020-05-14得票数 1
回答已采纳
我想从更大的swagger.json文件内容中替换示例json中的值，它太大了。
Error:
/usr/bin/jq: Argument list too long error bash
几天来一直致力于解决这个问题，但在这里找不到这个问题。这是示例json文件：
{
"name": "",
"description": "",
"context": "",
"version": "",
"provider":
浏览 0提问于2020-01-22得票数 6
我正在尝试使用connexion来创建REST，但是无法理解如何设置get操作来消耗对象数组。最后，我需要一次获得关于几个项目的信息。
使用Python3.7、connexion-2.3.0和Swagger与OpenAPI规范ver。2.
我的昂首阔步文件：
swagger: "2.0"
info:
description: "This is documentation for REST api test."
version: "1.0.0"
title: test
consumes:
- application/json
pr
浏览 1提问于2019-08-27得票数 3
回答已采纳
2回答
我在设置API时遇到了问题。我得到的错误如下： [
{
"message": "Wrong data in the response. ",
"error": [
{
"code": "INVALID_TYPE",
"params": [
"object",
"string"
],
"message": "E
浏览 34提问于2020-04-17得票数 2
我用Php编写API，并使用swagger (2.0)注释(lib：，使用)生成swagger.json，但是当我键入以下内容时，我遇到了以下问题：
/**
*
* Space Schema
*
* @SWG\Get(
* path="/api/v1/client/space/schema",
* @SWG\Response(
* response=200,
* description="OK",
* @SWG\Property(property="result",
浏览 6提问于2017-11-30得票数 2
回答已采纳
1回答
我有一个由gradle支持的SpringBoot应用程序，我们最初只是在这里创建
REST控制器，然后使用@EnableSwagger2注释创建我们的swagger。这是很好的工作，但现在我们想要过渡到API的第一种方法。
这意味着我们现在首先创建我们的swagger.json，然后使用swagger-codegen来生成我们的SpringBoot接口/控制器，以便在我们的SpringBoot应用程序中使用。我现在试图弄清楚如何让springfox-swagger-ui使用我们创建的swagger.json，而不是在事后查看java代码来生成UI。在我看来，这是正确的方法，以避免本质上的spr
浏览 0提问于2017-11-20得票数 5
回答已采纳
Swagger 在UI和JSON中没有显示参数，甚至我的方法都有参数，尤其是当我添加FromBody标记时
行动方法：
[HttpPost("Action")]
public IActionResult Action([FromBody] string message)
{
return Ok(message);
}
我使用了新的Asp.net核心3.1和2.2 web应用程序和API模板来测试这一点，我把它配置得与完全一样
ConfigureServices：
services.AddMvc();
services.Ad
浏览 3提问于2020-03-07得票数 1
回答已采纳
我成功地在java中使用Swagger/OpenApi v2.0使用OpenApi Generator CLI 3.3.2-SNAPSHOT生成了一个REST客户端。
但是我已经有了一个REST客户端，所以我只想从规范中生成一些模型。
当我跑步时，我会获得成功：
java -Dmodels -DmodelDocs=false \
-jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
-i swagger.json \
-g java \
-o /tem
浏览 0提问于2018-10-23得票数 2
如何使用选项"contentFormat"：" swagger -json“将swagger从ARM模板部署到Azure API管理
"contentFormat": "swagger-json",
"contentValue": "D:\\tempvsts\\APISwagger\\APISwagger\\swagger.json",
当我运行这个程序时，我会得到以下错误
"message"：“解析错误:解析值时遇到的意外字符: D. Path‘，第0行，位置0。”
浏览 2提问于2019-04-09得票数 0
我跟随向我的ASP.NET核心应用程序添加了swagger。
当我把它作为根网站托管时，它工作得很好，但是当我将应用程序作为别名托管在一个现有的网站上时，比如myserver.com/myapp，swagger会在一个不正确的URL和报告中查找swagger.json：*无法从https://myserver.com/swagger/v1/swagger.json中读取swagger JSON。它应该使用https://myserver.com/myapp/swagger/v1/swagger.json。
我得到的信息是：
无法从读取swagger JSON
如何配置swashbuck
浏览 4提问于2016-12-02得票数 3
对于这个问题，我已经有了一个大致的解决方案，但这是我第一次使用JQ，我觉得结果有点笨拙，我想要一些关于如何清理它的建议，或者如何使用更多惯用形式的建议。 我有一个swagger接口规范(full file here)，我想为每个路径、支持的方法和每种情况下期望的内容类型提取信息 例如，来自： {
"paths" : {
"/1.0/kb/paymentGateways/hosted/form/{accountId}" : {
"post" : {
"produces"
浏览 19提问于2020-01-17得票数 2
回答已采纳
1回答
我已经开发了一个使用Node和Express的REST服务。我已经集成Swagger来定义api文档。关于登录服务，这是我使用的swagger定义：
/**
* @swagger
* /api/v1.0/login:
* post:
* tags:
* - Login
* description: Login into system
* produces:
* - application/json
* parameters:
* - username: User
* description: The use
浏览 0提问于2018-11-01得票数 0
回答已采纳
我正在尝试Azure的API服务，并在文档之后公开了一个有效的Swagger模式供服务使用。我可以在本地服务器和API部署之后在其端点检索Swagger模式，并且我已经更新了我的web.config文件以包含应用程序/json类型。我的apiapp.json文件如下：
{
"$schema": "http://json-schema.org/schema#",
"id": "apiapp.dlxdev",
"namespace": "microsoft.com",
"gate
浏览 0提问于2015-11-26得票数 0
1回答
如何使Swagger核心生成openapi.json文档，并将其表示为String的一年月字段？
在代码中，我已经尝试了@JsonFormat和@JsonbDateFormat。
返回的实体正确地表示为字符串，格式正确，但文档总是以对象的形式生成。
环境：
io.swagger.core.v3.swagger-jaxrs2 2.1.9野蝇21.0.2 11
这里有一个片段：
@JsonbDateFormat(value = "uuuu-MM") // or "yyyy-MM", or @JsonFormat(shape = Shape.STRING, patte
浏览 15提问于2021-05-14得票数 3
回答已采纳
我正在使用Swagger编写文档。从注解生成json文件效果很好。此外，我希望以编程方式向生成的json文件添加更多路径。
我发现Swagger类有merge方法，所以我尝试反序列化我的json字符串，并像下面这样合并到Swagger对象中，但没有成功。
$swagger = \Swagger\scan($appDir);
$jsonString = json_encode([
"path" => [
"path" => "/api/task/{taskName}",
&
浏览 0提问于2017-09-12得票数 3
我有超过5k行长的swagger.json文件，描述了数百条路径和对象。我希望只使用端点的一部分生成一个TypeScript客户机(使用swagger-codegen)。我不希望生成的TypeScript应用程序包含与swagger.json未使用部分连接的类或接口
如何只过滤掉Swagger文档的一部分，描述指定的路径组(例如，以/api/*开头的所有路径)？特别是，我希望过滤后的JSON不包含未使用的数据结构的definitions。
浏览 9提问于2016-09-30得票数 1
回答已采纳
$("#nonjstest").click(function() {
$.ajax({
url:"https://petstore.swagger.io/v2/pet/findByStatus?status=sold",
type: "GET",
contentType:"application/json",
success: function(data){
alert(data[0].
浏览 27提问于2021-04-10得票数 0
回答已采纳
1回答
我对Swagger这个世界很陌生，我试图为我自己的应用程序实现它。我的问题是，SwaggerUi不接受我的swagger.yml文件，而是将它放入控制器中。事实上，我在身份验证方面有问题。
Swagger.yml
swagger: "2.0"
info:
version: "1.1"
title: ABC Operations
termsOfService: http://swagger.io/terms/
host: <HOST>
basePath: /abc/operations
tags:
- name: Stored Messa
浏览 1提问于2020-11-10得票数 1
回答已采纳
使用Restlet2.3.3，我声明我的Restlet应用程序是从SwaggerApplication派生的。当我访问默认/api-docs URI时，我注意到元数据的Swagger版本是1.2。随后，我无法在没有错误的情况下将其加载到Swagger中。
如何从Restlet的Swagger扩展获得Swagger2.0JSON？文档似乎表明它可以输出2.0版本的JSON。
谢谢!
浏览 4提问于2015-06-30得票数 2
回答已采纳
2回答
我使用Swagger来生成Restful：
@POST
@Consumes({ "application/json" })
@Produces({ "application/json" })
@io.swagger.annotations.ApiOperation(value = "Create a task", notes = "", response = Tasks.class)
@io.swagger.annotations.ApiResponses(value = {
@io.swagger.annotation
浏览 0提问于2015-12-01得票数 1
回答已采纳
我有一个控制器叫做'SampleController‘，它使用’MyControllerBase‘(来自NuGet包)作为基类。
我正在尝试使用swagger添加API文档，但是swagger无法获取'SampleController‘，因此无法创建swagger.json。
我收到错误消息"fetch error: /swagger/v1/swagger.json“
‘API’继承了'ControllerBase‘，所以'SampleController’就像一个MyControllerBase一样工作。
如何告诉swagger使用'MyCon
浏览 3提问于2019-07-01得票数 1
我正在尝试创建一个控制器，使用模块昂首阔步_用户界面_格式化程序来呈现一个swagger文档，该模块为文件字段提供一个格式化程序，该文件字段使用javascript库显示swagger文件(yml、yaml、json)，以像swagger网站做的那样显示文档。然后，在模块目录中复制yml文件，并在控制器中加载该文件。
public function buildApiDocumentation() {
$file_system = \Drupal::service('file_system');
$searchFiles = '/^.*\.(yml
浏览 0提问于2021-09-28得票数 0
1回答
在我的python-flask应用程序中，我使用实现swagger。我需要在参数的值中发送一个字典(或json)数组。但我在swagger ()的文档中找不到任何这样的类型。对于用户如何做到这一点，有什么建议吗？
浏览 0提问于2019-04-25得票数 0
我试图在操作中将一些json作为字符串传递，但它只适用于第一个参数。
以下是行动：
[HttpPost("testy")]
public string testyJson([FromBody] String json, [FromBody] String shortJson)
{
dynamic o = MyModule.replaceInJson(json, shortJson);
return "";
}
下面是我传递给这两个帕拉姆斯的json：
"{\"id\":1}"
这是结果
更多信息：
我正在使
浏览 3提问于2017-10-12得票数 3
回答已采纳
1回答
Swagger仅扫描带注释的资源
、、、、
有没有办法让swagger只扫描用@ApiModel和@ApiModelProperty注解的类和字段？
我使用的是Maven Swagger插件，问题是它会扫描完整的模型。这些模型包含仅用于内部处理的字段，一些字段仅用于我们的xml api，而另一些字段仅用于json api。
我希望swagger只扫描json api的字段。因此，我只想注释json字段。
我现在唯一的解决方案是注释每个字段，并将不需要的字段标记为“隐藏”。
你知道如何更容易地做到这一点吗？
浏览 0提问于2018-07-16得票数 0
3回答
我是编程API的新手。目前，我正在使用SwaggerUI for .NET
我想以JSON-格式回答请求：
{
"id": "value"
}
如何为我的值创建和返回这样的格式？例如，项目中的默认代码将返回
[
"value"
]
通过使用这个函数
public IEnumerable<string> Get()
{
return new string[] { "value1", "value2" };
}
如何返回将被swagger正确解释的JSON对象？
浏览 8提问于2016-12-15得票数 0
回答已采纳
3回答
我使用swagger记录resteasy的端点，并使用servlet使用如下方法提供swagger.json描述：
public void init(ServletConfig config) throws ServletException
{
super.init(config);
BeanConfig beanConfig = new BeanConfig();
beanConfig.setHost("localhost:8080");
beanConfig.setBasePath("/api");
be
浏览 4提问于2017-08-23得票数 12
回答已采纳
2回答
我有Swagger UI for API文档，我使用了与相同的方法来访问它，我使用了next URL：
http://localhost:9000/docs/swagger-ui/index.html?url=/assets/swagger.json
但是我想用http://localhost:9000/docs/代替。我不想使用WS进行委托，我想在routes中使用一行，如下所示：
GET /docs controllers.Assets.at(path:String="/public/lib/swagger-ui", file:String="index.html?
浏览 7提问于2017-10-06得票数 4
回答已采纳
我有一个使用C#编写的web，它位于ASP.NET 5/ EntityFrameworkCore的顶部。
在查询数据库时，我使用应用过滤器。
我需要手动将ODataQueryOptions应用到我的DbSet<>以生成分页信息。
这是我的密码
[Route("api/[controller]")]
[ApiController]
public class ProductsController : ControllerBase
{
private readonly DbContext _db;
public ProductsController(Db
浏览 7提问于2021-09-24得票数 3
回答已采纳
使用AspNetCore为IIS托管的web应用程序设置swagger。.json页面会加载，并且似乎可以正常使用所有的/swagger，但是当导航到{localhost} API查看UI页面时，我收到了一个404错误。我在Startup.cs中有以下代码：
//Configure Services
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
services.AddSwaggerGen(c =>
{
浏览 3提问于2019-07-15得票数 8
1回答
不同名称的Api版本
、、、
我在我的项目中使用asp dotnet core 3.1。目前，我正在通过1.0或2.1对我的操作进行版本控制，这是建议的方式。但我想通过schooljob或其他随机字符串值来控制操作的版本。我研究了很多，一些网站声称可以用1_0代替1.0，但没有说明如何做。另外，我不知道是否有可能将版本控制更改为schooljob。
我真正想做的是将URL从...someUrl/1.0/getTeachers更改为...someUrl/schooljob/getTeachers，这样我就可以在Swagger中更好地对它们进行分组。
// SchoolController.cs
[ApiVersion(
浏览 3提问于2020-09-08得票数 1
我是swagger-node的新手，我正在创建一个返回boolean类型数据的API方法。该方法的yaml为：
/IsBooting:
get:
summary: "Returns if the device is booting"
description: "Returns true when is in booting state"
x-swagger-router-controller: printer_status
operationId: IsBooting
responses:
20
浏览 8提问于2015-10-22得票数 6
我有以下JSON，这是我自己从代码中生成的。我基本上是在写代码来为UI生成swagger规范。我正在写一个新的，因为我仍然使用play 1.3，并且swagger模块已经有一段时间没有更新了。然而，我从我的代码生成器中获得了这个JSON，但是UI挂起在"fetching resource list：；list wait“。javascript控制台显示错误“正在获取”无法读取null“for swagger spec”的属性“参数”。我不知道该怎么做，任何帮助都将不胜感激。
{
"swagger": "2.0",
"info&#
浏览 135提问于2015-12-22得票数 3
回答已采纳
下面是jq命令，如下所示：jq '.. |."$ref"? | select(. != null)'，它在中工作
如何在Powershell中运行此命令？
我希望将所有返回的值都返回给PowerShell中的一个变量(列表/数组)。
我试过：
jq '.. |.'$ref'? | select(. != null)' .\swagger.json ->我得到了json文件中的所有内容。
jq '.. |."$ref"? | select(. != null)' .\swagger.js
浏览 3提问于2021-05-21得票数 0
我跟踪了，我的文档现在可以使用Swagger了。我还想以JSON或YAML的形式生成文档，以便在例如Postman中很容易导入，但是我在SwaggerModule中找不到任何合适的方法，Swagger也没有导出按钮。
浏览 1提问于2018-08-07得票数 12
回答已采纳
2回答
我想将从{service}/ Swagger /docs/v1获得的JSON中的swagger数据解析为动态生成的.NET类。
我面临的问题是，不同的API可以有不同数量的参数和操作。如何动态解析不同服务的Swagger JSON数据？
我的最终结果应该是所有API的列表，以及它在一个变量中的操作，我可以在这个变量上轻松地执行搜索。
浏览 0提问于2015-05-06得票数 4
我有一个简单的CXF-REST应用程序，对于其中一个服务，我有一个对象作为输入。其中一个参数是成功验证所必需的，然而，swagger-ui显示为可选或空。
如何更新它以显示“必填”或星标？
我试过使用@ApiModelProperty(required=true)，但是没有成功。
@Path("/user")
@Api(value = "/user", description = "User Service")
public interface UserService {
@POST
@Path("/saveUser&#
浏览 0提问于2018-01-16得票数 0
回答已采纳
在我的ASP.NET CoreWebAPI-5.0中，我正在实现Swagger。我有这个：
using System.Configuration;
public static class SwaggerExtension
{
public static IApplicationBuilder UseVersionedSwagger(this IApplicationBuilder app, IApiVersionDescriptionProvider provider)
{
// Enable middleware to serve generated Swa
浏览 4提问于2022-01-03得票数 0
回答已采纳
这是一个更普遍的问题。当我使用IE11、Chrome、FireFox等工具时，我的Swagger工作得很好，但是IE10和下一个错误：failed to parse JSON/YAML和My swagger.inspec().state正在返回"rejected"。
下面是我如何实例化我的客户端：
import { API_URI } from '../config/app_config'; // '/accountservice/swagger.json'
import Swagger from 'swagger-client'
浏览 4提问于2017-04-17得票数 0
回答已采纳
是否可以，如果可以，如何在Java中使用Camel REST DSL设置Swagger UI的示例值？ 我在Spring Boot中从org.webjars依赖项运行Swagger UI。 rest("/test").description("Some description").consumes("application/json").produces("application/json")
.post("/trigger").id("trigger")
浏览 23提问于2021-07-14得票数 0
回答已采纳
1回答
码头装船配置
、、
我正在按照说明使用swagger在码头从这里- 。我获得了使用docker工作的swagger，但是我无法使用SWAGGER_JSON环境变量来使用我自己的SWAGGER_JSON文件。
version: "3.9"
services:
swagger:
build: ./swagger
dockerfile: Dockerfile
ports:
- "8080:8080"
environment:
- SWAGGER_JSON=./swagger/swagger.json
Dockerfile
FROM swagge
浏览 2提问于2022-03-27得票数 0
回答已采纳
2回答
在构建时生成Swagger
、、、、
我正在从事一个ASP.NET核心WebAPI项目，并试图找到一种方法在构建时生成高傲的json？
由于我使用的是4个环境，所以我希望有4个swagger.json具有不同的名称，比如：
swagger_{appName}dev{buildNumber}.json
swagger_{appName}demo{buildNumber}.json
swagger_{appName}int{buildNumber}.json
Swagger_{appName}分期{buildNumber}.json
是否也可以编辑json中的字段？我想编辑(视环境而定)以下字段:主机、方案和b
浏览 1提问于2018-02-06得票数 10
我使用的是Ocelot网关和使用"MMLib.SwaggerForOcelot“库的swagger文档。对于某些swagger键，swagger显示“没有在规范中定义的操作！”傲慢的JSON将无路可走，就像
{
"openapi": "3.0.1",
"info": {
"title": "Admin API",
"version": "v1"
},
"paths": {},
"components": {
浏览 25提问于2022-05-20得票数 1
回答已采纳
我试图使用request从api端点获取数据，但是我得到了一个错误的密钥。在我的例子中，我提供了api键和端点url，所以我使用request获取数据的json内容，然后使用pandas创建数据框架。我查看了SO，但没有发现如何克服这一问题。有没有人有可能的想法或尝试来解决这个问题？如何从api端点正确地获取数据？有什么想法吗？
我的尝试
我试图从这个站点获取数据：
import requests
import pandas as pd
api_key = 'ec95a478-e46e-47f9-b57d-3d19012d527d'
url = 'https://ap
浏览 3提问于2020-11-25得票数 0
回答已采纳
我有一个ASP.NetCore操作方法，定义为：
[HttpGet]
public async Task<IActionResult> Get([FromQuery]Dictionary<string,string> values)
{
return Ok(JsonConvert.SerializeObject(values));
}
预期的查询将类似于：
http://localhost:36541/api?values[someProperty]=123&values[someOther]=234
当我使用Swashbuckle时，得到的swagger.
浏览 0提问于2018-04-18得票数 2
我正试图在startup.cs中配置swagger。如果我给出它所需的值“硬编码”，如下面的in ASP.NET Core : 2.2
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("V1", new Info { Title = "MY.API", Version ="v1" });
});
app.UseSwagger();
// Enable middleware to serve swagger-ui (HTML, JS, CSS, etc
浏览 0提问于2019-04-20得票数 0
回答已采纳
假设我有一个实现JSON的现有Java服务，并且我希望添加一个Swagger模式，并根据它自动验证请求和响应，而不对服务进行重组以使用Swagger框架/代码生成。有什么可以提供Java来绑定和传递有关请求/响应的信息来进行验证吗？
(仅仅使用JSON模式验证器就意味着手动实现Swagger中的许多附加特性。)
浏览 0提问于2016-04-07得票数 1
swagger版本1.5.20
public class SomeDto extends TemporallyScopedEntityDto {
@ApiModelProperty(value="This DOES NOT display in swagger ui docs")
private ZonedDateTimeDto publishDate;
@ApiModelProperty(value="This DOES display in swagger ui docs")
private List<CodeTy
浏览 2提问于2019-01-09得票数 4
1回答
我想使成为JSON文件中的一个表，
我使用Swagger (2.0)来描述API。opneapi.json托管在Gitlab中。
Swagger说，GFM语法可以用于富文本表示。
Gitlab对表的修饰标记(GFM)语法包括一个“回车”。
但是JSON不处理“回车”。
在openapi.json中包含表有什么解决办法吗？
浏览 0提问于2018-01-31得票数 6
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
