如何在WebAPI2中将/swagger更改为/help
在WebAPI2中，将/swagger更改为/help可以通过以下步骤实现：
- 打开WebAPI2项目的Global.asax.cs文件。
- 在Application_Start方法中，找到以下代码：
- 在Application_Start方法中，找到以下代码：
- 在该代码之后，添加以下代码：
- 在该代码之后，添加以下代码：
- 这段代码将启用Swagger和Swagger UI，并将API文档的版本设置为v1。
- 保存并重新编译项目。
现在，你可以在浏览器中访问/help路径来查看API文档和测试API。该路径将替代原来的/swagger路径。
Swagger是一个用于构建、文档化和调试Web API的开源工具。它提供了一个交互式的界面，可以方便地查看API的各种细节，包括请求和响应的参数、数据类型、错误码等。通过Swagger UI，开发人员可以直接在浏览器中测试API，并查看返回的结果。
推荐的腾讯云相关产品：腾讯云API网关。腾讯云API网关是一种高性能、高可用的API管理服务，可以帮助开发者快速构建和部署API，并提供丰富的监控和管理功能。通过腾讯云API网关，开发者可以轻松地管理和文档化API，并提供给其他开发者使用。
腾讯云API网关产品介绍链接地址：腾讯云API网关
相关·内容
我正在使用XMLWebAPI2制作一个应用程序接口，我使用swagger作为我的文档工具，并使用asp.net绑定它。现在，我想改变
http://localhost:1230/swagger
至
http://localhost:1230/help
我曾尝试在WebAPIConfig.cs上使用映射，例如
config.Routes.MapHttpRoute(
name: "help_ui_swagger",
routeTemplate: "help",
defaults: null,
浏览 3提问于2017-08-03得票数 0
回答已采纳
我有Asp.Net WebApi 2 project, Now converted into Asp.Net Core 2.0
具有数组属性的HttpGet方法无法绑定模型。
该模型在Asp.net Core2.0中为空(使用swagger进行测试)
需要做什么改变吗？
public class Customer
{
public string name { get; set; }
public new string[] systemId { get; set; }
}
CustomerController.cs
[HttpGet]
public IActionR
浏览 2提问于2017-10-17得票数 1
回答已采纳
我最近在Visual Studio2012中启动了一个WebAPI2项目，使用OWIN中间件通过OAuth2对用户进行身份验证。我结合了基于令牌的身份验证，就像在上所概述的那样。身份验证部分工作得很好。我已经添加了一些测试API方法，并且我想将Swagger挂接到我的API文档中。除了来自Swagger的API调用在授权时失败之外，我也让这部分工作了。
经过研究，我发现了关于如何将Swagger连接到OWIN中间件的。在根据post配置Swagger之后，我现在可以在Swagger UI上看到每个API方法旁边的authenticate按钮。但是，当尝试进行身份验证时，Swagger中的身份验
浏览 2提问于2016-06-29得票数 1
我使用Swashbuckle 5.6.0和Swashbuckle.Examples.3.5.1来记录WebApi2项目。我有一个操作，它使用XML主体并返回文本响应。我希望文档中包含一个XML输入的示例，例如<SampleXml><!-- example XML --></SampleXml>。
我的swagger输出如下，但为了这个问题，我将内容类型application/json添加到comsumes属性中。实际上，我只想允许application/xml和text/xml。
当我和Swagger一起看这个的时候，我看到：
当参数内容类型applic
浏览 3提问于2017-12-20得票数 2
我有一个具有以下模式的API网关： {
"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/). F
浏览 15提问于2021-03-24得票数 2
回答已采纳
我定义了一个羽化服务api，如下：
class Monitor {
find(_) {
const metrics = prom.register.metrics();
log.info(metrics);
return new Promise((resolve) => {
resolve({text: metrics});
});
}
}
function restFormatter(req, res) {
res.format({
'text/plain': function() {
lo
浏览 7提问于2017-06-29得票数 0
回答已采纳
我使用Swagger来记录我的服务(WebAPI2)。我正在寻找一种真正的轻量级方法，要求访问者在访问UI界面之前输入用户名/密码。
这就是我想要实现的结果：
我只希望对Swagger UI进行密码保护，而不是实际的服务。
我在web.config中尝试过授权规则，但无法让它工作(可能是因为UI文件夹实际上并不存在)。我也看过URL授权和基本身份验证，但我并没有真正取得进展。
我正在寻找最终结果，如下图所示：
任何指导都将不胜感激。
浏览 7提问于2016-02-08得票数 2
4回答
基于WebApi2的My控制器方法
[HttpGet]
public IEnumerable<Products> GetProducts(ProductSearchCriteria searchCriteria)
{
//searchCriteria is always null here!!! Why?
return db.Instance.LoadProducts(searchCriteria);
}
我的搜索标准类
public class ProductSearchCriteria
{
private
浏览 2提问于2017-03-23得票数 1
回答已采纳
伙计们：
我使用swagger来制作api文档。我使用ASP.NET WebAPI2开发WebAPI。我遇到了三个问题：
第一:如何为WebAPI控制器添加注释？我试着增加对Controller的评论
namespace IMCAPI.Controllers
{
/// <summary>
/// Value API
/// </summary>
[Authorize]
public class ValuesController : ApiController
{
// GET api/values
/// <summary>
///
浏览 4提问于2016-11-05得票数 2
我使用swagger文档(使用swashbuckle)开发WebApi2 REST API已经有一段时间了，但是在我的本地沙箱版本中，我无法访问SwaggerUI，也无法通过get请求访问swagger xml。我已经比较了我的代码版本之间的swagger设置，在这一方面没有任何代码更改。我已经卸载了swashbuckle和IISExpress，但没有任何效果。我的想法正在耗尽，我希望能就下一步尝试和调试swagger生成/或找出是否有任何日志记录，我可以打开帮助诊断进一步的建议。
很抱歉发布了这样一个一般性的问题，但我看了大约5个小时后感到不知所措。
谢谢
标记
浏览 0提问于2016-03-24得票数 0
我试着在heroku上加载我的LaravelL5-swaggerURL，但是我得到和空白的屏幕。在用chrome检查检查视图时，我发现了下面的错误
https://MY_APP_NAME.herokuapp.com/api/documentation' was loaded over HTTPS, but requested an insecure script 'http://MY_APP_NAME.herokuapp.com/docs/asset/swagger-ui-standalone-preset.js?v=2fb7deffbc136bc6540eb1aa890ca7
浏览 18提问于2022-03-14得票数 2
我正在创建一个dotnet 6 webapi应用程序来提供REST API。我可以创建该项目，并通过Mac上的终端运行，并访问来查看Swagger。当我尝试运行运行docker-compose run --rm server的Docker时，问题出现了。我无法访问Swagger并在浏览器选项卡上获得HTTP错误403。我也在API/Program.cs的app.UseHttpsRedirection();中注释了这一行。
我的文件夹结构是
my-project
-API/
- Folder with the webapi template
-dockerfiles/
- Docke
浏览 0提问于2021-11-16得票数 0
1回答
我正在使用Node Js和swagger，我用swagger编写了我的api文档，几个月前我曾经访问过它。
Now i do not remember the URL which i used to add to browser to read documentation, which i have written in swagger. Please help me finding that URL.
浏览 1提问于2018-12-04得票数 1
回答已采纳
1回答
我正在尝试为我的WebAPI2服务函数设置可选参数。以下是路径的定义：
[HttpGet, Route("mp/CEG/{ST?}/{PR?}/{DES?}"), ResponseType(typeof(CEG))]
public object CEG(string ST = null, string PR = null, string DES = null)
但是，当我按下面的方式记录它并尝试在Swagger UI中运行测试(使用Swashbuckle构建)时，所有参数都声明它们是必需的，并且我不能提交没有参数的测试。
XMLDoc：
/// <summary>
浏览 4提问于2016-12-12得票数 0
回答已采纳
1回答
让我简要地描述一下我现在面临的问题。
我已经为webflux应用程序配置了spring安全，当我尝试访问不需要身份验证的路由时，会收到登录表单提示。路由是/swagger-ui/，它应该在没有任何登录表单或其他东西的情况下打开。
下面是我在SecurityWebFilterChain中拥有的代码
@Bean
public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
//@formatter:off
return http
.formLogin().dis
浏览 0提问于2020-08-27得票数 3
2回答
问题是，我们想在jelly bean 4.2.2版本中运行该应用程序，..I尝试在eclpise中升级minSdkVersion和targetSdkVersion当我在4.2.2中尝试它时，应用程序崩溃了我的API .I也转到了Windows>preferences>android >平台已经4.2.2了
我在请求help..please帮助！！
浏览 2提问于2014-01-01得票数 0
1回答
我正在编写我的第一个托管在Azure上的webapi2控制器应用程序。
我正在使用swagger来测试apis。
我现在正在编写通过webapi2控制器方法写入数据库的第一个方法。
当我进入swagger来测试我在"example value“中看到的方法时，我正在写的表以及所有与它有关系的表。
这向我抛出了一个危险信号，因为有人可以根据我看到的内容直接将值写入这些表中，而不会受到限制。
示例表是account表：
{
"id": "string",
"email": "string",
&
浏览 1提问于2017-02-02得票数 0
回答已采纳
3回答
我得到的错误是"'help‘对象不可迭代“。如何从db获取最新记录并将其显示在目标html页上？
我的views.py是
def about_experiment(request,ex_link_name):
researcher = None
study = None
posts = None
if request.method == 'POST':
form = AboutHelp(request.POST)
posts = help.objects.filter().order_by('
浏览 16提问于2017-07-03得票数 0
回答已采纳
我目前正在研究Azure应用程序服务，因为我对于使用swashbuckler生成swagger元数据有点困惑。为此，我阅读了下面的文档，因为它们提到要查看元数据，只需在API url末尾添加swagger/docs/v1即可。
我也做了同样的事情，我能够以JSON的形式看到我的元数据生成。但是，当我在API url末尾添加swagger/help/v1或swagger/help/v2时，我没有得到任何JSON格式的元数据。
是否有任何理由只使用swagger/docs/v1来生成JSON格式的swagger元数据，或者其他类似swagger/help/v1等的元数据。
浏览 1提问于2016-12-06得票数 1
回答已采纳
1回答
在使用ASP.NET WebApi2和Swashbuckle/Swagger时，我尝试使用FromUri属性绑定对象，如下所示：
[RoutePrefix("api/v1/example")]
public class ExampleController : ApiController
{
[HttpGet]
[Route("{id}")]
public ExampleModel Get(string id, [FromUri]ExampleModel searchCriteria)
{
...
}
}
publ
浏览 0提问于2017-06-07得票数 3
我使用了一个名为swagger-tools的节点模块，它在内部依赖于lodash。当安装了swagger工具时，它的node_modules文件夹的深度非常大，这会导致我的azure web应用程序(一个Windows服务器)出现错误。我在某个地方看到这个问题可以通过使用npm 3来解决，虽然npm 3安装在azure服务器上，但我不能强迫它使用它-错误日志表明npm 2正在被使用。我在package.json中是这样做的：
"engineStrict": true,
"engines" : {
"npm" : ">=3.0.0
浏览 0提问于2016-08-16得票数 0
我正在使用drf将swagger自动模式添加到我的端点。swagger在/api/v1/swagger/在我的本地设置中是可见的，这个链接运行良好，我正在根据需要得到合适的模式。
但是，当我的应用程序部署在服务器上时访问同一个链接时，它显示了一个"django登录“超链接，如下所示：
这个"django登录“超链接正在导航到SERVER_IP/accounts/login/?next=/api/v1/swagger/，其中显示了404Notfind页面为：。
尽管openAPI yaml文件正在成功地从服务器上的端点生成，但是UI没有变得可见。
在堆栈溢出中有一个类似的问题
浏览 11提问于2022-05-13得票数 0
2回答
如何在中启用Swagger
、、、、
我正在使用，并为我的移动端设置了Easy和Easy。
我想知道如何为Azure应用程序服务设置Swagger。
当我试图导航到API (例如)时，有人说“要访问swagger，必须通过添加swagger: true进行配置并安装swagger-ui npm模块来启用swagger支持”。
当您没有API的源代码(它是使用Easy自动创建的)时，您如何确切地添加swagger-ui npm？
浏览 2提问于2016-07-22得票数 4
回答已采纳
3回答
我有一个基于WCF REST的服务，我想添加Swagger。我已经安装了Swagger.NET包，我的项目使用的是.NET 4.0。我还启用了XML文档等。但现在我不确定从这里出发的最好路线。
当我启动http://localhost/SwaggerUI/index.html时，我得到了带有http://YOUR-URL-HERE:PORT/api/swagger的默认页面。我不确定应该在这里放什么url。我通过：<standardEndpoint name="" helpEnabled="true" />启用了服务的帮助，它给了我一个难看的页面：h
浏览 0提问于2013-06-12得票数 5
回答已采纳
1回答
使用多个微服务时的自吹自擂
、、、、
我对在我们的微服务体系结构中使用swagger感兴趣。每个微服务都是用.NET (WebApi2)编写的，并且是一个单独的应用程序(但是，同一个主机，只是不同的路径)。理想情况下，我想要一个描述所有API的大刀阔斧的规范，然后使用它来生成客户端c#，以便这些API的所有使用者都有模型的定义，也有服务的调用者。
这有可能做到吗？我读过它是从2.0开始的，但是没有找到任何具体的例子。我已经开始使用一些.NET标记库，它们似乎都在应用程序中安装了swagger，因此每个微服务都有效地托管了自己的API。
谢谢你的帮助。
浏览 0提问于2015-04-30得票数 4
我在AWS EC2实例(Ubuntu)上测试我的Flask应用程序。
主应用程序：
from sonip.api.factory import create_app
app = create_app()
def main():
app.run(debug=True, threaded=True)
if __name__ == "__main__":
main()
烧瓶应用程序的实际设置是在工厂中完成的，包括注册blueprint等。
def create_app():
app = Flask(__name__)
app.config['S
浏览 1提问于2018-05-16得票数 1
回答已采纳
我想将JSON作为缺省值添加到POST请求主体的这个swagger端点中。为了我的一生，我无法弄清楚这种格式应该是什么，以添加一个非常大的JSON对象作为POST端点的缺省值。参见下面的示例swagger规范
{
"consumes": [
"application/x-www-form-urlencoded"
],
"definitions": {},
"info": {
"title": "swagger help",
"version":
浏览 24提问于2022-09-09得票数 0
我有一个Swagger配置的问题。
现在Swagger正在扫描包并创建漂亮的文档，但我想使用我的YAML (如果不可能使用YAML，则使用JSON )文件。
这是我的Swagger配置类：
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.ba
浏览 0提问于2018-06-20得票数 5
我有一些R水管工文件工作使用RStudio，下一步是通过码头。
指令
source('R/to_run_api_shirin_docker.R')
Starting server to listen on port 8000
不要工作，并运行以下命令：
$ docker run -p 8000:8000 plumber_demo:v4
R version 3.6.3 (2020-02-29) -- "Holding the Windsock"
Copyright (C) 2020 The R Foundation for Statistical Computi
浏览 2提问于2020-07-22得票数 2
我在我的webapi2文档中使用swagger。我从github下载了源代码，并试图根据我的响应类型更改源代码。我遇到了响应类型的问题，即我想在其中一个get方法上指定responsetype属性，所以我使用了[ResponseType(typeof(List<Student>))] ([ResponseType(typeof(List<Student>))]是我的类，我想返回模型模式中的学生属性)，但它在文档中返回IHttpActionResult作为模型，空值作为模型模式，有没有其他方法可以访问代码中的responsetype属性，以便我可以返回模型的属性...
请
浏览 2提问于2015-04-27得票数 2
我有一个json规范(webapi.json)，并希望使用swashbuckle呈现相同的规范。有什么方法可以做到这一点吗？ 我的configure方法如下所示 public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseMv
浏览 13提问于2019-03-18得票数 1
回答已采纳
3回答
正在尝试在Ubuntu上安装go-swagger。我已经安装了brew(Linuxbrew)：
sh -c "$(curl -fsSL https://raw.githubusercontent.com/Linuxbrew/install/master/install.sh)"
接下来，我这样做了：
brew tap go-swagger/go-swagger
brew install go-swagger
键入未找到的命令：swagger version：未找到命令。还有别的(-help，-version不工作)我做错了什么吗？
浏览 11提问于2020-02-25得票数 0
正如Swagger所提供的，我正在使用伟大的插件为我的REST生成Asciidoc文档。我遵循了，并使用Spring集成测试从Springfox端点生成标记(我使用的是Maven)：
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = { AppConfig.class, SwaggerConfig.class })
public class DocumentationIT {
protected MockMvc mockMvc;
@Autowired
protected WebAppl
浏览 6提问于2016-09-26得票数 1
回答已采纳
我想将swagger添加到我的停靠组合设置中。我用的是postgres和。我的设置大致类似于：
version: '3'
services:
postgrest:
image: postgrest/postgrest
ports:
- 3000:3000
links:
- postgres
postgres:
image: postgres
ports:
- 5432:5432
volumes:
- "./pgdata:/var/lib/post
浏览 1提问于2018-11-06得票数 1
回答已采纳
我已经将swagger添加到我的Startup.cs文件中，它显示我的api很好，除非有人在url中更改了单词"Help“的大写。如果我像这样输入url : api，这会把我带到正确的文档，但是如果我输入：，这会把我带到默认的swagger petstore api。
有人能帮我解决这个问题吗？我工作的公司要求它在大写"Help“或不大写”Help“的情况下工作。
浏览 12提问于2021-06-05得票数 1
我为API键向Swagger添加了一个header参数，这可以提供输入API键的能力。我使用以下方法
Swashbuckle.AspNetCore 6.1Swashbuckle.AspNetCore.Swagger 6.1Swashbuckle.AspNetCore.SwaggerGen 6.1Swashbuckle.AspNetCore.SwaggerUI 6.1
我的代码如下所示:在Startup.cs中添加Swagger配置的位置如下
public void ConfigureServices(IServiceCollection services)
浏览 0提问于2021-03-22得票数 0
无法解析引用，因为:无法解析指针:/定义/错误在文档中不存在
我遵循这个链接，但是在为自定义响应消息添加globalResponseMessage()方法时没有出错，我不知道原因是什么。请help....TIA
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
浏览 1提问于2018-03-31得票数 6
我在上跟踪openapi的micronaut，并且UI没有生成，每次我试图访问/swagger时，/swagger-ui都会出现以下错误：
{
"message": "Not Found",
"_links": {
"self": {
"href": "/swagger",
"templated": false
}
},
"_embedded": {
"errors": [
{
浏览 7提问于2022-10-21得票数 2
回答已采纳
1回答
我有一个现有的C# Swagger WebAPI2项目(.NET 4.6.1)，其中我需要集成Swagger来生成文档以及客户端SDK(目前只有C# )。这是在其最新版本(5.5.3)中使用Swashbuckle完成的。
除了一件事之外，一切都很顺利。我遇到的问题是，在我的SwaggerConfig.cs中定义的安全性(通过HTTP头)最终出现在输出JSON中，但不知何故它并没有链接到任何方法(即使它是强制的)。
我的安全配置定义如下：
GlobalConfiguration.Configuration.EnableSwagger(c =>
{
c.SingleApiVersio
浏览 0提问于2017-05-24得票数 3
1回答
我正在使用Spring Boot创建一个新的Rest API，使用Swagger来记录它，并且我不能更改web上显示的示例值。我可以在模型中更改它，但不能在POST参数中更改。
以下是我的依赖项：
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.4.RELEASE</versi
浏览 3提问于2019-05-02得票数 5
回答已采纳
即使我在FTL文件上使用了下面一行：
new Alfresco.widget.DashletTitleBarActions("args.htmlid")
.setOptions({"actions":[{"bubbleOnClick":
{"message":'${msg("dashlet.help")}'},"cssClass":"help","tooltip":'${msg("dashlet.help.tooltip")}&
浏览 2提问于2015-03-13得票数 0
回答已采纳
1回答
我在我的web项目中使用Swashbuckle包，我试图用这个替换默认的Swagger
但我一直收到这条错误信息
<?xml version="1.0" encoding="ISO-8859-1"?>
<Error>
<Message>An error has occurred.</Message>
<ExceptionMessage>Embedded resource not found - ReportsAPI.swagger-ui.Index.html</ExceptionMessage&g
浏览 0提问于2019-05-09得票数 0
回答已采纳
我正在尝试使用本地swagger.json文件在swagger文档中显示。
我的swagger.json文件位于/home/user1/swagger-ui/dist/swagger.json下，index.html位于同一目录下。我对index.html进行了如下修改。
window.swaggerUi = new SwaggerUi({
spec: ../swagger.json
url: url,
dom_id: "swagger-ui-container",
使用docker run -p 80:8080 swagger-ui-builder启
浏览 3提问于2016-07-11得票数 3
我使用的是ASP.NET核心6天气预报样本。在我的开发环境中，我可以运行这个应用程序，它将“默认”页面显示为localhost:xxxx/swagger/index.html。
在生产中，默认值不显示；如果我使用完整的https://example.com/swagger，我可以访问它
如何使ASP.NET核心6(在生产中)默认为该页面？
我试过：
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute("default", "{controller=swagger}");
});
浏览 12提问于2022-01-04得票数 0
1回答
有人有处理AcceptVerb (例如“搜索”) OpenAPI路径操作的经验吗？它引发一个错误，因为"search“不是Swagger接受的已接受的HTTP方法。
/dnlds/bwaaccount:
summary: Searches for BOSS accounts
description: >-
Receives a BOSS search request and then the API will search the BOSS database.
search:
这是我的API中的方法签名：
[AcceptVerbs("S
浏览 5提问于2022-06-03得票数 1
运行./sbt assembly之后，我尝试运行
./bin/runscala.sh src/main/scala/com/wordnik/swagger/codegen/BasicPHPGenerator.scala ~/Desktop/myspec.json
我得到了以下错误：
./src/main/scala/com/wordnik/swagger/codegen/BasicPHPGenerator.scala:17:错误:非法开始定义
封装com.wordnik.swagger.codegen
原因是什么，我该如何解决呢？
浏览 3提问于2015-01-19得票数 0
回答已采纳
19回答
我正在使用Swashbuckle为webapi2项目生成swagger文档\UI。我们的模型与一些遗留接口共享，因此在模型上有几个属性我想忽略。我不能使用JsonIgnore属性，因为遗留接口也需要序列化为JSON，所以我不想忽略全局的属性，只是在Swashbuckle配置中。
我在这里找到了一种做这个的方法：
但这似乎已经过时了，目前的斯瓦什巴克尔发行版。
为旧版本的Swashbuckle推荐的方法是使用IModelFilter实现，如下所示：
public class OmitIgnoredProperties : IModelFilter
{
public void Apply
浏览 23提问于2016-12-06得票数 82
回答已采纳
我正在开发C#和sql server2012。我是.Net核心的新手。我想为我的工作涵盖.net核心的WebAPI2，所以我想要基本的想法，即如何在WebAPI2和.net核心中完成CRUD操作。谢谢。
浏览 2提问于2017-02-21得票数 0
我有一个有两个端点的控制器类。
@RestController
@RequestMapping
public class TestController {
@RequestMapping(
value= "/test",
method = RequestMethod.GET)
@ResponseBody
public String getTest() {
return "test without params";
}
@RequestMapping(
value=
浏览 39提问于2018-08-16得票数 4
1回答
如何在windows上本地运行swagger文件？我知道我们可以在上试用它，但是我把swagger文件分割成多个文件，所以我想知道如何在windows上运行它。
浏览 3提问于2022-01-04得票数 0
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
对象存储
即时通信 IM活动推荐
腾讯云开发者
