How to configure to allow Swagger URL?

[Mohit-3196]

To add your application URL to Swagger:

1. Clone the Ant Media Server parent directory
   git clone https://github.com/ant-media/Ant-Media-Server.git

2. Go to the Ant Media Server directory
   cd Ant-Media-Server;

3. Run the compile command
   mvn clean compile com.github.kongchen:swagger-maven-plugin:generate;

4. After the build is successful, you will see a swagger.json file under target/swagger directory

ubuntu@ip-172-31-7-34:~/Ant-Media-Server/target$ ls
classes  generated-sources  maven-status  swagger
ubuntu@ip-172-31-7-34:~/Ant-Media-Server/target$ cd swagger/
ubuntu@ip-172-31-7-34:~/Ant-Media-Server/target/swagger$ ls
swagger.json

5. Go to https://editor-next.swagger.io/

6. And copy the content of swagger.json and paste

7. Change the host URL to match your Ant Media Server URL and it's ready.

Note

• If you are running Ant Media Server v2.7.0 or below, please use java 11 and Maven 3.9.5
• If you are running Ant Media Server v2.8.0 and above, please use java 17 and Maven 3.9.5
• To build your swagger UI webpage, checkout this tutorial: https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/

Parent post: #4453