API Client Boilerplate .NET SDK
A repository template for .NET API client projects
View the Project on GitHub GuilhermeStracini/apiclient-boilerplate-dotnet
API Client boilerplate template
💡 🏗️ A boilerplate API client template for .NET API client wrappers
About
This is a template repository that sets the basic code and infrastructure for a repository/solution in .NET C# to create an API client wrapper (sometimes known as SDK).
[!Note]
A appveyor.yml file is included for AppVeyor CI pipeline. AppVeyor is free for open-source projects. For closed-source projects, consider a paid subscription or other CI tools (GitHub Actions, CircleCI, TeamCity).
Instructions
[!Warning]
The automated process listed below now supports Windows and Linux/MAC environments.
Automated process
- Click on the green button USE THIS TEMPLATE
- Give a name to your new project/repository
- Clone your newly created repository to your machine
- Execute/run the file
initial-setup.batorinitial-setup.ps1and follow the instructions on the prompt/terminal
Manual process
- Click on the green button USE THIS TEMPLATE
- Give a name to your new project/repository
- Clone your newly created repository to your machine
- Delete this file (
README.md) and renameREADME.template.mdtoREADME.md - Change the
appveyor.ymlwith your tokens (use secure tokens) or use your preferred CI tool (Circle CI, GitHub Actions, Jenkins, Team City, Azure DevOps) - Change
SolutionName.slnto your solution/project name - Change project name (
SolutionName.csproj,SolutionName.Tests.csproj,SolutionName.IntegrationTests.csproj) and namespace inside directoriesSrcandTests - Change the package name in the
SolutionName.csprojfile - Change the main project reference in the tests project in files
Tests/SolutionName.Tests.csprojandTests/SolutionName.IntegrationTests.csproj - Fix in the
README.mdthe path of the badges. (change all {username}/{repo} tokens with your own data) - Add to
README.mdusage instructions of your client/SDK - Update
_config.ymlwith project details (github.io docs website)
License
Licensed under: MIT license (LICENSE or http://opensource.org/licenses/MIT).
This will also be your project’s LICENSE, but you can change it to another one that suits your needs.