blocks|key|82221|text|我不清楚你到底想做什么，但我会给出两个解决方案：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|82222|如果你想要路径参数，比如GET+/test+&+GET+/test/123，你可以这样做：|offset|length|style|CODE|82223|++@GetMapping("/test")
++public+String+getTest()+{
++++return+"test+without+params";
++}

++@GetMapping("test/{param}")
++public+String+getTest(@PathVariable("param")+int+param)+{
++++return+"test+with+param";
++}|code-block|syntax|javascript|82224|如果需要查询参数(GET+/test和GET+/test?param=123)，则需要一个带有可选参数的端点：|82225|++@GetMapping("test")
++public+String+getTest(@RequestParam("param")+Integer+param)+{
++++if(param+==+null)+{+
++++++return+"test+without+params";
++++}+else+{
++++++return+"test+with+param";
++++}
++}|82226|entityMap^0|0|C|9|O|D|0|0|9|9|J|J|0|0^^$0|@$1|2|3|4|5|6|7|S|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|T|8|@$D|U|E|V|F|G]|$D|W|E|X|F|G]]|9|@]|A|$]]|$1|H|3|I|5|J|7|Y|8|@]|9|@]|A|$K|L]]|$1|M|3|N|5|6|7|Z|8|@$D|10|E|11|F|G]|$D|12|E|13|F|G]]|9|@]|A|$]]|$1|O|3|P|5|J|7|14|8|@]|9|@]|A|$K|L]]|$1|Q|3|-4|5|6|7|15|8|@]|9|@]|A|$]]]|R|$]]

I'm unclear exactly what you're attempting to do, but I'll give two solutions:

If you want to have PATH parameters e.g. <code>GET /test</code> &amp; <code>GET /test/123</code> you can do:

<pre><code> @GetMapping("/test")
 public String getTest() {
 return "test without params";
 }

 @GetMapping("test/{param}")
 public String getTest(@PathVariable("param") int param) {
 return "test with param";
 }
</code></pre>

If you want query parameters (<code>GET /test</code> and <code>GET /test?param=123</code>) then you need a single endpoint that takes an optional parameter:

<pre><code> @GetMapping("test")
 public String getTest(@RequestParam("param") Integer param) {
 if(param == null) { 
 return "test without params";
 } else {
 return "test with param";
 }
 }
</code></pre>

blocks|key|2811332|text|尝试在路径中包含参数，如下所示。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2811333|@GetMapping("/test/{param}")
public+String+getTest(@PathVariable+final+int+param)+{
++++return+"test+with+param";
}|code-block|syntax|javascript|2811334|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

Try including the param in the path as below.

<pre><code>@GetMapping("/test/{param}")
public String getTest(@PathVariable final int param) {
 return "test with param";
}
</code></pre>

blocks|key|2811401|text|问题出在您的请求映射中，第二个方法声明覆盖了第一个方法。因为资源映射值相同。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2811402|尝试将第二种方法更改为下面的方法。由于您希望在QueryParam而不是path变量中提供输入，因此应该使用@RequestParam而不是@PathParam。|2811403|请注意，您必须提供/test/，以便告诉Spring您的映射是不明确的。希望能有所帮助。|2811404|@RequestMapping(
++++++++++value=+"/test/",
++++++++++method+=+RequestMethod.GET)
++@ResponseBody
++public+String+getTest+(@RequestParam("param")+int+param)+{
++++return+"test+with+param"%2Bparam;
++}|code-block|syntax|javascript|2811405|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|N|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|O|8|@]|9|@]|A|$]]|$1|F|3|G|5|H|7|P|8|@]|9|@]|A|$I|J]]|$1|K|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]]|L|$]]

The issue is in your Request Mapping, The second method declaration is overriding the first method. As Resource Mapping value is same.

Try changing the second method to below. As you want to give input in QueryParam rather than path variable, you should use @RequestParam not @PathParam. 

Note that you have to give /test/, In order to tell Spring that your mapping is not ambiguous. Hope it helps.

<pre><code>@RequestMapping(
 value= "/test/",
 method = RequestMethod.GET)
 @ResponseBody
 public String getTest (@RequestParam("param") int param) {
 return "test with param"+param;
 }
</code></pre>

blocks|key|82318|text|在阅读说明时，这里的问题是swagger-ui正在做正确的事情。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|82319|您有两个控制器端点，但它们用于接受一组可选查询参数的相同资源/test。|offset|length|style|CODE|82320|实际上，具有相同方法(GET)和请求映射(/test)的所有映射控制器端点代表单个逻辑资源。test资源上的GET操作，以及一组可能影响调用该操作的结果的可选参数。|82321|您将其实现为两个独立的控制器端点的事实是一个实现细节，并且不会改变可以对单个/test资源进行操作的事实。|82322|在swagger+UI中将其作为两个单独的端点列出，与使用可选参数的单个端点相比，对API的消费者有什么好处？也许它可以限制允许的有效查询参数集(如果设置了?foo，则必须设置&bar)，但这也可以在描述性文本中完成，这是一种更标准的方法。就我个人而言，我不熟悉任何公开记录的api，这些api通过查询参数来区分同一资源的多个操作。|82323|entityMap^0|0|U|5|0|B|3|L|5|1A|4|0|12|5|0|26|4|2G|4|0^^$0|@$1|2|3|4|5|6|7|P|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|Q|8|@$D|R|E|S|F|G]]|9|@]|A|$]]|$1|H|3|I|5|6|7|T|8|@$D|U|E|V|F|G]|$D|W|E|X|F|G]|$D|Y|E|Z|F|G]]|9|@]|A|$]]|$1|J|3|K|5|6|7|10|8|@$D|11|E|12|F|G]]|9|@]|A|$]]|$1|L|3|M|5|6|7|13|8|@$D|14|E|15|F|G]|$D|16|E|17|F|G]]|9|@]|A|$]]|$1|N|3|-4|5|6|7|18|8|@]|9|@]|A|$]]]|O|$]]

Upon reading clarifications, the issue here is that swagger-ui is doing the correct thing.
You have two controller endpoints, but they are for the same RESOURCE <code>/test</code> that takes a set of optional query parameters.
Effectively, all mapped controller endpoints that have the same method (<code>GET</code>) and request mapping (<code>/test</code>) represent a single logical resource. GET operation on the <code>test</code> resource, and a set of optional parameters which may affect the results of invoking that operation.
The fact that you've implemented this as two separate controller endpoints is an implementation detail and does not change the fact that there is a single <code>/test</code> resource that can be operated upon.
What would be the benefit to consumers of your API by listing this as two separate endpoints in swagger UI vs a single endpoint with optional parameters? Perhaps it could constrain the set of allowed valid query parameters (if you set <code>?foo</code> you MUST set <code>&amp;bar</code>) but this can also be done in descriptive text, and is a much more standard approach. Personally, I am unfamiliar with any publicly documented api that distinguishes multiple operations for the same resource differentiated by query params.

I have a controller class with two endpoints

<pre><code>@RestController
@RequestMapping
public class TestController {

 @RequestMapping(
 value= "/test",
 method = RequestMethod.GET)
 @ResponseBody
 public String getTest() {
 return "test without params";
 }

 @RequestMapping(
 value= "/test",
 params = {"param"},
 method = RequestMethod.GET)
 @ResponseBody
 public String getTest(@PathParam("param") int param) {
 return "test with param";
 }

}
</code></pre>

One has a parameter, one doesn't, and the both work.

If I use curl or a web browser to hit the endpoints

<blockquote>
 <a href="http://localhost:8081/test" rel="nofollow noreferrer">http://localhost:8081/test</a>
</blockquote>

returns

<blockquote>
 test without params
</blockquote>

and

<blockquote>
 <a href="http://localhost:8081/test?param=1" rel="nofollow noreferrer">http://localhost:8081/test?param=1</a>
</blockquote>

returns

<blockquote>
 test with param
</blockquote>

but the swagger ui only shows the one without a parameter.

If I change the value in the request mapping for the request with a parameter to

<pre><code> @RequestMapping(
 value= "/testbyparam",
 params = {"param"},
 method = RequestMethod.GET)
</code></pre>

Swagger UI displays both endpoints correctly, but I'd rather not define my endpoints based on what swagger will or won't display.

Is there any way for me to get swagger ui to properly display endpoints with matching values, but different parameters?

Edit for Clarification:

The endpoints work perfectly fine; /test and /test?param=1 both work perfectly, the issue is that swagger-ui won't display them.

I would like for swagger ui to display the endpoints I have defined, but if it can't, then I'll just have to live with swagger-ui missing some of my endpoints.

Edit with reference:

The people answering here: <a href="https://stackoverflow.com/questions/9637297/proper-rest-formatted-url-with-date-ranges">Proper REST formatted URL with date ranges</a>

explicitly say not to seperate the query string with a slash

They also said "There shouldn't be a slash before the query string."

How to get Swagger UI to display similar Spring Boot REST endpoints?

我有一个有两个端点的控制器类。@RestController@RequestMappingpublic class TestController {  @RequestMapping(          value= "/test",          method = RequestMethod.GET)  @Res...

问如何让Swagger UI显示类似的Spring Boot REST端点？
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何让Swagger UI显示类似的Spring Boot REST端点？EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何让Swagger UI显示类似的Spring Boot REST端点？
EN