kvanderscheer/naeo-2023-api

NAEO 2023 Demo API

A simple Spring Boot REST API used as a teaching aid for the NAEO 2023 Advanced IS/SQL Training Workshop.

API Docs · Report Bug · Request Feature

About The Project

This project, the naeo-2023-api, is a Java Spring Boot application that exposes a simple set of REST endpoints for working with the NAEO 2023 Conference agenda.

This the naeo-2023-api was developed specifically as a teaching aid and should not be considered production ready.

Latest Release

The latest tagged version is:

(back to top)

Built With

• 
• 

(back to top)

Getting Started

There are only a few steps to get the API up running and in a local development environment.

Prerequisites

• Maven
• Java 17 SDK

Running the application

1. Clone the repo

   git clone https://github.com/kvanderscheer/naeo-2023-api.git

2. Run the application locally with maven.

   mvn clean spring-boot:run

Optional: Import the project into your IDE of choice.

(back to top)

Sample Data

Sample data is not included in the repository, but can be added by including a data.sql in the project's resources folder.

Usage

This is a simple Spring Boot project that exposes a basic REST API. A demo is deployed to AWS at the following URLs:

• API Endpoint: https://naeo2023api.vanderscheer.us/v1
• OpenAPI Endpoint: https://naeo2023api.vanderscheer.us/api-docs/v1
• Documentation: https://naeo2023api.vanderscheer.us/swagger-ui/index.html

For the demo API, method security for POST, PUT, and DELETE operations is provided by an AWS API Gateway using API keys.

(back to top)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Kurt VanderScheer - kvanderscheer@gmail.com

Project Link: https://github.com/kvanderscheer/naeo-2023-api

(back to top)

Acknowledgments

(back to top)