Registering the OpenAPI API in the Toolkit
Registering the OpenAPI API in the Toolkit
An OpenAPI API that has been registered in Azure API Management (APIM) and had its operations manually retrieved into the Toolkit by selecting “Fetch operations from Azure” from the API options ellipsis (⋮) menu.
Testing fetch post by id
Although the properties in the OpenAPI specification are defined using lowercase names, the Toolkit automatically capitalises all entity property names to align with C# conventions. According to Microsoft’s .NET naming guidelines, public members such as properties should use Pascal casing, where each word begins with an uppercase letter. As a result, all properties in the data model have been capitalised to ensure compatibility with C# standards and to avoid conflicts or unexpected behaviour at runtime.
For more details, see Microsoft’s .NET Naming Guidelines.
Post Virtual Entity schema definition
Ensure that the Insert and View permissions are granted to your User role.
using System;
using System.Web.Http;
using System.Web.Http.OData.Extensions;
using openapitutorial.Custom;
namespace openapitutorial
{
/*
For additional details on using OData in ASP.NET Web API, visit the following link.
https://docs.microsoft.com/en-za/aspnet/web-api/overview/odata-support-in-aspnet-web-api/
*/
public static partial class WebApiConfig
{
static partial void CustomRegister(System.Web.Http.HttpConfiguration config)
{
// Web API configuration and services
// Web API routes
config.MapHttpAttributeRoutes();
System.Web.Http.OData.Builder.ODataConventionModelBuilder builder = new System.Web.Http.OData.Builder.ODataConventionModelBuilder();
//builder.EntitySet<ClassName>("ClassName");
builder.EntitySet<Custom.Post>("Post");
config.Routes.MapODataServiceRoute("odata", "odata", builder.GetEdmModel());
}
}
}
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace openapitutorial.Custom
{
/*
The following code should be added to the WebApiConfig class to add this class to the Service Root
builder.EntitySet<Custom.Post>("Post");
*/
public class Post
{
public int UserId { get; set; }
public string Id { get; set; }
public string Title { get; set; }
public string Body { get; set; }
}
}
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Net.Http;
using System.Net.Http.Headers;
using Newtonsoft.Json;
namespace openapitutorial.Custom
{
public class PostsAPI
{
/**To replace the API’s URL comment below, navigate to Third Party Services > APIs in the Toolkit, locate your API, and copy its URL.**/
private static readonly string _baseUrl = //***"API_URL"***//;
public static List<Post> Posts()
{
var httpClient = new ComUnity.DataServices.ServiceUtility.ComUnityHttpClient(//***"Application Name"***//, //***"Azure API name"***//);
var res = httpClient.GetAsync($"{_baseUrl}/posts").Result;
res.EnsureSuccessStatusCode();
var content = res.Content.ReadAsStringAsync().Result;
var posts = Newtonsoft.Json.JsonConvert.DeserializeObject<List<Post>>(content);
return posts.ToList();
}
public static Post GetPost(string id)
{
var httpClient = new ComUnity.DataServices.ServiceUtility.ComUnityHttpClient (//***"Application Name"***//, //***"Azure API name"***//);
var response = httpClient.GetAsync($"{_baseUrl}/posts/{id}").Result;
response.EnsureSuccessStatusCode();
var content = response.Content.ReadAsStringAsync().Result;
return Newtonsoft.Json.JsonConvert.DeserializeObject<Post>(content);
}
public static Post AddPost(string body)
{
var httpClient = new ComUnity.DataServices.ServiceUtility.ComUnityHttpClient (//***"Application Name"***//, //***"Azure API name"***//);
HttpRequestMessage mess = new HttpRequestMessage(HttpMethod.Post, $"{_baseUrl}/posts");
mess.Content = new StringContent(body);
mess.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
var response = httpClient.SendAsync(mess).Result;
if (response.IsSuccessStatusCode) {
var content = response.Content.ReadAsStringAsync().Result;
return Newtonsoft.Json.JsonConvert.DeserializeObject<Post>(content);
}
return null;
}
}
}
using System.Linq;
using System.Web.Http.OData;
using System.Web.Http.OData.Query;
using System.Web.Http.OData.Routing;
namespace openapitutorial.Custom
{
public class PostController : System.Web.Http.OData.ODataController
{
// GET: odata/Posts
[EnableQuery]
public IQueryable<Post> GetPost()
{
return PostsAPI.Posts().AsQueryable();
}
[EnableQuery]
public Post GetPost([System.Web.Http.OData.FromODataUri] string key)
{
return PostsAPI.GetPost(key);
}
//POST: odata/Posts
public System.Web.Http.IHttpActionResult Post()
{
var bb = Request.Content.ReadAsStreamAsync().Result;
bb.Position = 0;
var byteArray = new byte[bb.Length];
bb.Read(byteArray, 0, (int)bb.Length);
var body = System.Text.Encoding.Default.GetString(byteArray);
var post = PostsAPI.AddPost(body);
if (post == null) return BadRequest("Failed to add a post.");
return Created(post);
}
}
}
LINK:<<Sytem Default Name of the Post by ID screen>>?postId={{= Id }}
The JSONPlaceholder API simulates a successful record creation (201 Created) for POST requests, but no actual data is stored. The API response is mocked and does not persist changes.
Posts screen in the application