Payara Micro是一个轻量级的Java EE应用服务器,它是Payara Server的一个子集
首先,您需要将OpenAPI UI的依赖项添加到项目的pom.xml
文件中。您可以使用Maven Central Repository中的OpenAPI UI库。将以下依赖项添加到<dependencies>
部分:
<dependency>
<groupId>org.webjars</groupId>
<artifactId>swagger-ui-dist</artifactId>
<version>3.48.0</version>
</dependency>
接下来,您需要在Payara Micro中配置OpenAPI UI。创建一个名为openapi-config.yaml
的文件,并将其放在项目的src/main/resources/META-INF
目录下。在此文件中,您可以配置OpenAPI UI的设置,例如指定要扫描的API包。
openapi:
info:
title: Your API Title
version: 1.0.0
servers:
- url: http://localhost:8080/
paths:
/{path}:
get:
summary: Your API Summary
responses:
'200':
description: OK
使用Maven将项目打包为WAR文件:
mvn clean package
将生成的WAR文件部署到Payara Micro。您可以使用以下命令:
java -jar payara-micro.jar --deploy target/your-application.war
部署完成后,您可以通过访问以下URL来查看OpenAPI UI:
http://localhost:8080/swagger-ui/
这将显示一个包含您的API文档的界面。