Skip to main content

API Documentation

An Overview
Overview pending
Tutorials & Workflow
In this project we are following below steps for create new API, Flow as under-
Examples & Testing tools

In this project I have use Swagger for test our API you can use Pastman also.
Swagger-Swagger is a suite of tools for API developers from SmartBear Software and a former specification upon which the OpenAPI Specification is based.
Why use Swagger
public action method in your controllers can be tested from the Swagger UI. Click a method name to expand the section, add the necessary parameters, if any and click Try it out!. You can see the responses as well as the expected model. Similar one goes for a POST request as well. You can see the expected model for the request and test it out with a sample model from the Swager UI itself. No need for POSTMAN or other tools for testing the API. Pretty cool right.
Postman-Postman is an API client that makes it easy for developers to create, share, test and document APIs. With this open-source solution, users can create and save simple and complex HTTP/s requests, as well as read their responses.
Postman
Card image cap
Postman Hit

Above image I have use Postman for test our API.

Request Image
Swagger
Card image cap
Swagger Hit

Above image I have use Swagger for testing our API.

Request Image
File structure
  • OakstoneInsiderAPI
    •  _Start
      • C#   RouteConfig.cs
      • C#   SwaggerConfig.cs
      • C#   WebApiConfig.cs
    •  BusinessLayer
      • C#   InsiderHome.cs
    •   Controller
      • C#   InsiderHomeController.cs
    •   Custom
      • C#   EmailUtility.cs
    •  CustomeContent
      •   Images
    •  DBHelper
      • C#  DBHelper.cs
    •  LogDetailsFile
      • C#   Logdetails.cs
    •  Models
      •     InsiderHome
        • C#   M_HomeInsider.cs
      • C# CommonModel.cs
Version & Freamworks
Freamworks and IDE is blow-
  • Visual Studio 2013
  •   .Net Freamwork 4.5
  •      Swagger 5.6.0

Home

Save 20% with your CME purchase of $395 or more, made between May 19 and May 30. Use Code: CME20

Save 25%. Use Code: CME25 or Get a $500 Amazon.com® Gift Card. Use Code: GC500
*Minimum purchase required, exclusions apply