api-template
API Template pack provides an opinionated implementation guide to making use of popular leading .net framework based tools and utilities to assist developers to quickly and efficiently develop secure, stable and resilient REST APIβs.
File Explorer
Download Latest Version (.zip)- build-deploy.yml
- pr.yaml
- dependabot.yml
- FUNDING.yml
- PULL_REQUEST_TEMPLATE.md
- head_custom.html
- custom.scss
- favicon.png
- favicon.svg
- repr-pattern.png
- rest-api.png
- vertical-slice.png
- 5-principles-api-design.png
- api-solution-view.png
- api-template-pack-github.png
- apipacklogo.png
- apitemplatepack.png
- apitemplatepack.svg
- backend-for-frontend-pattern.png
- crud-endpoints.png
- custom-method.png
- database-project.png
- database-viewer-connect.png
- dto-generation.png
- empty-commands.png
- force-overwrite-error.png
- generated-command.png
- getting-started-api-template-pack.png
- github-logo.png
- installation.png
- napptive-sponsor.png
- postgres-database-connection-connect-schema.png
- postgres-database-connection-connect.png
- postgres-database-connection.png
- query-success-create.png
- repr-pattern.png
- repr-pattern.svg
- rest-api.png
- site-logo.png
- solution-view.png
- success-command-generated.png
- threenine-sponsor.png
- vertical-slice.png
- vertical-slise.svg
- build.md
- what-is-cake.md
- changelog.md
- context-factory.md
- context.md
- database-project.md
- databases.md
- dependency-injection.md
- entity-project.md
- entity-type-configuration.md
- entity-validation.md
- domain.md
- api-design-principles.md
- api-first-principle.md
- backends-for-frontends-pattern.md
- cqrs-introduction.md
- introduction.md
- microservices-architecture.md
- repr-pattern.md
- resource-based-api.md
- vertical-slice.md
- what-is-rest.md
- knowledge.md
- postgres.md
- api-project.md
- api-solution.md
- command-endpoint.md
- crud-endpoints.md
- database-project.md
- domain-generation.md
- getting-started.md
- model-configuration.md
- query-endpoint.md
- start-new-solution.md
- tutorials.md
- .gitignore
- 404.html
- _config-development.yml
- _config.yml
- CNAME
- favicon.ico
- Gemfile
- Gemfile.lock
- index.md
- README.md
- template.json
- CommandRequest.Command.cs
- CommandRequest.cs
- CommandRequest.Handler.cs
- CommandRequest.Mapping.cs
- CommandRequest.Response.cs
- CommandRequest.Validator.cs
- Routes.cs
- template.json
- Patch.Command.cs
- Patch.cs
- Patch.Handler.cs
- Patch.Mapping.cs
- Patch.Response.cs
- Patch.Validator.cs
- Post.Command.cs
- Post.cs
- Post.Handler.cs
- Post.Mapping.cs
- Post.Response.cs
- Post.Validator.cs
- Put.Command.cs
- Put.cs
- Put.Handler.cs
- Put.Mapping.cs
- Put.Response.cs
- Put.Validator.cs
- GetAll.cs
- GetAll.Handler.cs
- GetAll.Mapping.cs
- GetAll.Query.cs
- GetAll.Response.cs
- GetAll.Validator.cs
- GetbyId.cs
- GetbyId.Handler.cs
- GetbyId.Mapping.cs
- GetbyId.Query.cs
- GetbyId.Response.cs
- GetbyId.Validator.cs
- Routes.cs
- template.json
- .gitkeep
- .gitkeep
- .gitkeep
- DatabaseProject.csproj
- DatabaseProjectContext.cs
- DatabaseProjectContextFactory.cs
- Directory.Build.props
- InternalConstants.cs
- README.md
- .gitkeep
- Directory.Build.props
- Entities.csproj
- Directory.Build.props
- Directory.Packages.props
- template.json
- Domx.cs
- Domx.cs
- Domx.cs
- Domx.cs
- Domx.cs
- Domx.cs
- template.json
- EntityName.cs
- template.json
- ModelConfiguration.cs
- template.json
- .gitkeep
- LoggingBehaviour.cs
- ValidationBehaviour.cs
- ApiProjectException.cs
- NotFoundException.cs
- JsonPatchDocumentFilter.cs
- ExceptionHandlingMiddleware.cs
- launchSettings.json
- ApiProject.csproj
- appsettings.Development.json
- appsettings.json
- Directory.Build.props
- Directory.Packages.props
- Program.cs
- README.md
- template.json
- QueryRequest.cs
- QueryRequest.Handler.cs
- QueryRequest.Mapping.cs
- QueryRequest.Query.cs
- QueryRequest.Response.cs
- QueryRequest.Validator.cs
- Routes.cs
- template.json
- LoggingBehaviour.cs
- ValidationBehaviour.cs
- .gitkeep
- ApiException.cs
- NotFoundException.cs
- JsonPatchDocumentFilter.cs
- ValidatorsRegistration.cs
- ExceptionHandlingMiddleware.cs
- launchSettings.json
- Api.csproj
- appsettings.Development.json
- appsettings.json
- Directory.Build.props
- Program.cs
- README.md
- Common.csproj
- ConnectionStringNames.cs
- RegularExpressions.cs
- .gitkeep
- .gitkeep
- .gitkeep
- ApiSolutionContext.cs
- ApiSolutionContextFactory.cs
- appsettings.json
- Database.csproj
- DependencyInjection.cs
- Directory.Build.props
- Initializer.cs
- InternalConstants.cs
- README.md
- ApiSolution.cs
- Directory.Build.props
- Entities.csproj
- Directory.Build.props
- Domain.csproj
- Domain1.cs
- Directory.Build.props
- Should_be_200_Ok.js
- Should_be_201.js
- Should_be_400.js
- Should_be_404.js
- Should_be_500.js
- Should_be_conflict.js
- solution-get-tests.http
- .httpyac.json
- http-client.env.json
- Integration.csproj
- .gitkeep
- Unit.csproj
- Directory.Build.props
- .env
- .gitignore
- ApiSolution.sln
- build.cake
- Directory.Build.props
- Directory.Packages.props
- Dockerfile
- GitVersion.yml
- local-dev-docker-compose.yml
- README.md
- readme.md
- Templates.csproj
- .editorconfig
- .gitattributes
- .gitignore
- ApiTemplatePack.sln
- build.cake
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- Directory.Build.props
- GitVersion.yml
- icon.png
- LICENSE
- pull-request.cake
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/threenine/api-template
Downloads the entire project code from GitHub to your computer.
cd api-template
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f src/Solution/Dockerfile -t api-template .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 api-template
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. .NET
MediumPrerequisites
dotnet restore
Downloads the packages the project depends on.
dotnet run
Builds the project and runs it immediately.
After dotnet run, check the message or address shown in the terminal.
// repository documentation
Was this content helpful?
(0 ratings)