CodedThought.Core.Data.ApiServer
2.0.0.11
dotnet add package CodedThought.Core.Data.ApiServer --version 2.0.0.11
NuGet\Install-Package CodedThought.Core.Data.ApiServer -Version 2.0.0.11
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CodedThought.Core.Data.ApiServer" Version="2.0.0.11" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CodedThought.Core.Data.ApiServer" Version="2.0.0.11" />
<PackageReference Include="CodedThought.Core.Data.ApiServer" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CodedThought.Core.Data.ApiServer --version 2.0.0.11
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CodedThought.Core.Data.ApiServer, 2.0.0.11"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package CodedThought.Core.Data.ApiServer@2.0.0.11
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=CodedThought.Core.Data.ApiServer&version=2.0.0.11
#tool nuget:?package=CodedThought.Core.Data.ApiServer&version=2.0.0.11
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
CodedThought.Core.Data.ApiServer
A .NET Core Data Entity Provider for REST APIs.
Requirements
ApiServer requires CodedThough.Core.Configuration and CodedThought.Core. These can be found in NuGet. - CodedThought.Core.Configuration - CodedThought.Core
Usage
- Install required packages. See requirements above.
- Add the Api Connection settings in the appSetting.json or a custom .json file.
Note: See CodedThought.Core.Configuration for JSON configuration specifications.
- Add a new class and inherit from
CodedThough.Core.Data.GenericApiDataStoreController. Below is a sample class file.
[ApiController]
[Route("api/[controller]/[action]")]
[Produces("application/json")]
public class AppApiController : GenericApiDataStoreController {
public AppApiController(IMemoryCache cache, CodedThough.Core.Configuration.ConnectionSetting connectionSetting){
try{
DataStore = new GenericApiDataStore(cache, connectionSetting)
} catch {
throw;
}
}
public async Task<ApiResponse<Person>> GetPeople(string email) {
try {
ParameterCollection param = DataStore.CreateParameterCollection();
param.AddApiParameter(DataStore.GetApiParameterNameFromProperty<Person>("EmailAddress"), email);
ApiResponse<Person> response = await DataStore.Get<ApiResponse<Person>, Person>(action: "person", param);
return response;
} catch {
throw;
}
}
}
///<summary>
/// Generic response class to accept the data or value response, any message,
/// and status code for the call.
////</summary>
public class ApiResponse<T>{
public List<T> Data { get; set; }
public object? Value { get; set; }
public string? Message { get; set; }
public HttpStatusCode StatusCode { get; set; }
public ApiResponse(){
Data = new List<T>();
Value = null;
StatusCode = HttpStatusCode.OK;
}
public ApiResponse(List<T> data, string? message){
Data = data;
Message = message;
Value = null;
}
}
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- CodedThought.Core (>= 8.0.1.33)
- CodedThought.Core.Configuration (>= 8.0.1)
- Microsoft.Data.SqlClient (>= 6.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Added new connection setting extensions to easily get an ApiConnectionSetting.