#Maven Archetype API template

#Maven archetype to generate an API with suppport for openapi/tracing/metrics/etc

Table of Contents

• Table of Contents
• ❗ Code of Conduct
• Project Structure
• 🙌🏻 How to Contribute
• 🛠️ How to Use
• 📝 License
• Contributors ✨

❗ Code of Conduct

We expect everyone to abide by our Code of Conduct. Please read it. 🤝

Project Structure

├── LICENSE
├── output.txt
├── pom.xml
├── README.md
└── src
    ├── main
    │   └── resources
    │       ├── archetype-resources # Files that will be used to generate the new project
    │       │   ├── app
    │       │   │   ├── pom.xml
    │       │   │   └── src
    │       │   │       ├── main
    │       │   │       │   ├── java
    │       │   │       │   │   ├── App.java
    │       │   │       │   │   ├── auth
    │       │   │       │   │   │   └── SecurityConfiguration.java
    │       │   │       │   │   ├── exceptions
    │       │   │       │   │   │   └── NotReturnedException.java
    │       │   │       │   │   └── greeting
    │       │   │       │   │       ├── GreetingController.java
    │       │   │       │   │       └── GreetingService.java
    │       │   │       │   └── resources
    │       │   │       └── test
    │       │   │           └── java
    │       │   │               └── AppTest.java
    │       │   ├── pom.xml
    │       │   └── spec
    │       │       ├── openapi.yaml
    │       │       └── pom.xml
    │       └── META-INF
    │           └── maven
    │               └── archetype-metadata.xml #Define archetype properties and rules
    └── test
        └── resources
            └── projects
                └── hello
                    ├── archetype.properties
                    └── goal.txt

🙌🏻 How to Contribute

Check out our Contributing Guide for information on contributing.

🛠️ How to Use

Before proceeding, ensure the following tools are installed and properly configured:

• Git
• Maven
• Java 17+

Clone the repository and install the archetype to your local Maven repository:

git clone https://github.com/xgeekshq/xgeeks-maven-archetype-api
cd xgeeks-maven-archetype-api
mvn clean install

Once installed, navigate to the target directory and run the following command:

mvn archetype:generate -DarchetypeGroupId=com.xgeeks.template \
    -DarchetypeArtifactId=maven-archetype-api \
    -DgroupId=<GroupId> \
    -DartifactId=<ArtifactId> \
    -Dversion=<version> \
    <Additional parameters>

You can replace <GroupId>, <ArtifactId>, <version> and <Additional parameters> with your own values. This template supports the following additional parameters:

Parameter	Description	Default Value
IncludeOpenAPIGenerator	Enable support for code generation from an openapi spec file	false

📝 License

Licensed under the MIT License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

---

xgeeks Open Source