Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xunzer/cli_commander
An API that stores and retrieves CLI commands you often forget.
https://github.com/xunzer/cli_commander
asp-net-core azure crud csharp docker mvc-architecture rest-api sql-server swagger-ui
Last synced: about 1 month ago
JSON representation
An API that stores and retrieves CLI commands you often forget.
- Host: GitHub
- URL: https://github.com/xunzer/cli_commander
- Owner: Xunzer
- Created: 2024-08-27T06:14:20.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-31T08:43:38.000Z (3 months ago)
- Last Synced: 2024-10-12T07:01:17.946Z (about 1 month ago)
- Topics: asp-net-core, azure, crud, csharp, docker, mvc-architecture, rest-api, sql-server, swagger-ui
- Language: C#
- Homepage: http://clicommanderapicontainer.d0fmcwgzeyb3fkea.canadacentral.azurecontainer.io/index.html
- Size: 4.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CLI Commander REST API (ASP.NET Core MVC)
## [Please click here to access the site.](http://clicommanderapicontainer.d0fmcwgzeyb3fkea.canadacentral.azurecontainer.io/index.html)
#### An API that stores and retrieves CLI commands you often forget.
### The goal of this project is to explore concepts related to:
- Building a REST API
- ASP.NET Core
- Entity Framework
- MVC Pattern
- C#
### By applying:
- RESTful API principles
- Repository design pattern
- Dependency injection
- SQL Server Express and SSMS
- Entity Framework Core O/RM (DBContext, Migration)
- Data Transfer Object (DTO)
- AutoMapper
- HTTP methods (GET, POST, PUT, PATCH, DELETE, status codes)
- Postman and Swagger UI (for testing endpoints purpose)
- Docker (image, container and delopyed on Docker Hub)
- Azure (Deployed Docker Image and moved SQL Database from local)
### Application Architecture:
### API Endpoints (CRUD):
| URI | Verb | Operation | Description | Success | Failure |
|:------------------ |:----------- |:----------- |:-------------------------- |:------------- |:----------------------------------- |
|/api/commands |GET |READ |Read all resources |200 OK |400 Bad Request, 404 Not Found |
|/api/commands/{id} |GET |READ |Read a single resource |200 OK |400 Bad Request, 404 Not Found |
|/api/commands |POST |CREATE |Create a new resource |201 Created |400 Bad Request, 405 Not Allowed |
|/api/commands/{id} |PUT |UPDATE |Update an entire resource |204 No Content |.. |
|/api/commands/{id} |PATCH |UPDATE |Update partial resource |204 No Content |.. |
|/api/commands/{id} |DELETE |DELETE |Delete a single resource |204 No Content |.. |
### Website UI:
### Testing with Postman:
#### [HttpGet] Returns all commands and a "200 OK" status code.
