Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattsimoessilva/friendconnect-api
FriendConnect-API is a RESTful API built with ASP.NET Core, designed to manage and connect friends. It provides endpoints for creating, retrieving, updating, and deleting ‘Friend’ resources. This API forms the backbone of the FriendConnect application, enabling users to manage their connections efficiently and effectively.
https://github.com/mattsimoessilva/friendconnect-api
asp-net-core mit-license open-source restful-api
Last synced: about 2 months ago
JSON representation
FriendConnect-API is a RESTful API built with ASP.NET Core, designed to manage and connect friends. It provides endpoints for creating, retrieving, updating, and deleting ‘Friend’ resources. This API forms the backbone of the FriendConnect application, enabling users to manage their connections efficiently and effectively.
- Host: GitHub
- URL: https://github.com/mattsimoessilva/friendconnect-api
- Owner: mattsimoessilva
- License: mit
- Created: 2023-11-08T13:06:09.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-09T17:14:07.000Z (about 1 year ago)
- Last Synced: 2023-11-10T15:10:52.208Z (about 1 year ago)
- Topics: asp-net-core, mit-license, open-source, restful-api
- Language: C#
- Homepage:
- Size: 77.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# FriendConnect-API
## Description
FriendConnect-API is a RESTful API built with ASP.NET Core, designed to manage and connect friends. It provides endpoints for creating, retrieving, updating, and deleting 'Friend' resources. This API forms the backbone of the FriendConnect application, enabling users to manage their connections efficiently and effectively.
## Getting Started
### Prerequisites
- .NET Core 3.1 or later
- An IDE such as Visual Studio or VS Code
### Installation
1. Clone the repository
```bash
git clone https://github.com/username/FriendConnect-API.git
```
2. Navigate to the project directory
```bash
cd FriendConnect-API
```
3. Restore the packages
```bash
dotnet restore
```
4. Build the project
```bash
dotnet build
```
5. Run the project
```bash
dotnet run
```
## Usage
The API exposes the following endpoints:
- `GET /api/friend`: Retrieves a list of all friends.
- `GET /api/friend/{id}`: Retrieves a friend by ID.
- `POST /api/friend`: Creates a new friend.
- `PUT /api/friend/{id}`: Updates a friend by ID.
- `DELETE /api/friend/{id}`: Deletes a friend by ID.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)