如何为接口生成swagger文档？

Question

我谷歌了一下，但是所有关于昂首阔步留档的例子都使用了类。我想包括接口，因为读者感兴趣的是API而不是实现。

这是我的密码：

包括所需的maven依赖项：

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>

我的SpringBoot应用程序：

package com.manojk.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

我的RestController接口

package com.manojk.demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping(value = "/") // this annotation needed for swagger-ui to work
public interface HelloWorldControllerInterface {
    @GetMapping
    String helloWorld();
}

和实施

package com.manojk.demo;

import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Component // this annotation needed to initialize this controller
public class HelloWorldController implements HelloWorldControllerInterface {
    @Override
    public String helloWorld(){
        return "Hello World";
    }
}

这一切都由所需的昂首阔步配置支持：

package com.manojk.demo;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import static springfox.documentation.builders.PathSelectors.regex;

/**
 * Configuration class for Swagger REST API documentation
 *
 */
@Configuration
@EnableSwagger2
/**
 * Run nad hit http://localhost:8080/swagger-ui.html to see it working
 */
public class SwaggerConfig {

  /**
   * @return Swagger Docker
   */
  @Bean
  public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            // .apis(RequestHandlerSelectors.basePackage("com.siemens.oss.domain.controller.service")) # does not work for interfaces
            .apis(RequestHandlerSelectors.basePackage("com.manojk.demo")) // works for implementations
            .paths(regex("/.*"))
            .build();
  }
}

该代码可作为maven项目在https://github.com/MKhotele/spring-examples/tree/master/demo.

http://localhost:8080/swagger-ui.html显示"Hello World Controller"，但没有显示"Hello World Controller Interface"。

有可能使招摇过市包括接口吗？怎样

Answer 1

Segii Zhevzhyk在评论中提供了提示。谢谢

这应该是不可能的，因此也不可能。

OpenAPI规范（以前称为Swagger规范）不仅仅是关于RESTAPI的规范。这也是与他们互动的过程。接口永远不能公开与之交互的endpoint；但这只是一个实现。

Swagger是一套围绕OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录和使用REST API。

正如OpenAPI规范简介中所述，

OpenAPI规范（OAS）定义了一个标准的、与语言无关的RESTful API接口，它允许人类和计算机在不访问源代码、留档或流量检查的情况下发现和理解服务的功能。如果定义正确，消费者可以理解远程服务并与之交互，只需最少的实现逻辑。