Assignment 2: Address Book API

Table of Contents

1. About The Project
   • Built With
2. Installation
3. Maintainers
4. Contributing
5. License

About The Project

This project is a .NET/C# API case that demonstrates the developer's skills in building a functional and efficient API using .NET 6.0. The project includes a simple SQL database and allows for CRUD operations on address data. Additionally, it features filtering and sorting functionality for searching through address data, and includes an endpoint for calculating the distance between two addresses using a public geolocation API. Overall, this project showcases the developer's ability to build a well-structured and scalable API that follows best practices and includes thorough documentation.

While developing the AddressBookAPI project, I am proud of the clean and structured code that I have written, and the functionality that I have implemented for creating, retrieving, updating, and deleting addresses from a SQL database through the API endpoints. However, I was not able to finalize the Swagger implementation for documenting the endpoints and the implementation of the functionality to calculate the distance between two addresses using a public geolocation API. Despite my best efforts, I was unable to complete these requirements within the given timeframe.

See NET_C# case 2022.pdf for more detailed requirements for this assignment.

Created by Ahmad Khodabaks.

(back to top)

Built With

• C#
• .NET 6.0

(back to top)

Installation

1. Clone the repo

   git clone https://github.com/AhmadKhodabaks/AddressBookAPI.git

2. Run the program by start debugging.

(back to top)

Maintainers

• Ahmad Khodabaks

(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.

(back to top)