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 for .NET 🔷
🏗️ A modern and easy-to-use boilerplate for building .NET API client wrappers (also known as SDKs).
🌟 About
This repository is a template designed to kickstart your journey in creating robust API client wrappers using .NET C#.
Save time and effort with a preconfigured solution that includes essential tools and CI pipeline setup.
🔧 Key features:
- 🛠️ .NET Solution Setup: Ready-to-use structure for source code, unit tests, and integration tests.
- ✅ CI Integration: Includes a sample AppVeyor CI pipeline configuration with
appveyor.yml.💡 Tip: AppVeyor is free for open-source projects. Consider alternatives like GitHub Actions, CircleCI, or Azure DevOps for private repositories.
🚀 Getting Started
⚡ Automated Setup
Follow these quick steps for a hassle-free experience:
- Click the green “Use this template” button at the top.
- Name your new repository and clone it to your machine.
- Run the initial setup script:
- 🪟 On Windows: Execute
initial-setup.batorinitial-setup.ps1 - 🐧 On Linux/Mac: Execute
initial-setup.sh
- 🪟 On Windows: Execute
- Follow the prompts and enjoy! 🎉
🛠️ Manual Setup
Would you prefer to do it step-by-step? No problem!
- Click the green “Use this template” button.
- Clone your newly created repository.
- Delete this file (
README.md) and renameREADME.template.mdtoREADME.md. - Update the following files with your project details:
appveyor.yml→ Add secure tokens or configure your preferred CI tool.SolutionName.sln→ Replace with your solution name.- Project files (
SolutionName.csproj,SolutionName.Tests.csproj,SolutionName.IntegrationTests.csproj).- Update namespaces and project names inside the
SrcandTestsdirectories.
- Update namespaces and project names inside the
README.md→ Fix badge paths ({username}/{repo}) and add usage instructions._config.yml→ Update with project details for the GitHub Pages documentation site.
- ⚙️ Final touches:
- Adjust test project references in
Tests/SolutionName.Tests.csprojandTests/SolutionName.IntegrationTests.csproj. - Update the package name in your main project file.
- Adjust test project references in
🏷️ License
📄 This project is licensed under the MIT License.
Feel free to use it as is or replace it with a license that suits your needs.
| 🔗 View LICENSE | Read More About MIT |
🎉 Contribute & Customize
💬 Questions? Ideas? Open an issue or fork this repository to make it your own!
Don’t forget to ⭐ star the project if this template saved you time. 😄
🔷 Happy Coding in .NET! 🎯