Write API spec in Typescript with code completion then upload your json! Check the getting started page on how to get started.
serviceName: SecretService
baseUrls:
- http://localhost:4010
- http://localhost:8080
endpoints:
- url: /agents/getAgentByName
name: getAgentByName
requestModel:
name: GetAgentByNameRequest
fields:
- name: name
type: string
type: Object
responseModel:
name: GetAgentByNameResponse
fields:
- name: error
type:
ref: Grenade
type: NullableReference
- name: agent
type:
ref: Agent
type: Reference
type: Object
referenceTypes:
- name: Agent
fields:
- name: name
type: string
- name: age
type: int
- name: department
type: string
type: Object
- name: Grenade
fields:
- name: code
type: int
- name: msg
type: string
- name: name
type: string
type: Object
{
"serviceName": "SecretService",
"baseUrls": [
"http://localhost:4010",
"http://localhost:8080"
],
"endpoints": [
{
"url": "/agents/getAgentByName",
"name": "getAgentByName",
"requestModel": {
"name": "GetAgentByNameRequest",
"fields": [
{
"name": "name",
"type": "string"
}
],
"type": "Object"
},
"responseModel": {
"name": "GetAgentByNameResponse",
"fields": [
{
"name": "error",
"type": {
"ref": "Grenade",
"type": "NullableReference"
}
},
{
"name": "agent",
"type": {
"ref": "Agent",
"type": "Reference"
}
}
],
"type": "Object"
}
}
],
"referenceTypes": [
{
"name": "Agent",
"fields": [
{
"name": "name",
"type": "string"
},
{
"name": "age",
"type": "int"
},
{
"name": "department",
"type": "string"
}
],
"type": "Object"
},
{
"name": "Grenade",
"fields": [
{
"name": "code",
"type": "int"
},
{
"name": "msg",
"type": "string"
},
{
"name": "name",
"type": "string"
}
],
"type": "Object"
}
]
}API Documentation
Generate request and response models, client SDK, Open API Spec in an instant
Request and Response Models in Every Languages
export interface Agent
{
name: string;
age: number;
department: string;
}
export interface Grenade
{
code: number;
msg: string;
name: string;
}
export interface GetAgentByNameRequest
{
name: string;
}
export interface GetAgentByNameResponse
{
error: Grenade | null;
agent: Agent;
}
Generate Http Client From the Spec So You Don't Have to Craft Your Own!
export interface Agent
{
name: string;
age: number;
department: string;
}
export interface Grenade
{
code: number;
msg: string;
name: string;
}
export interface GetAgentByNameRequest
{
name: string;
}
export interface GetAgentByNameResponse
{
error: Grenade | null;
agent: Agent;
}
export async function getAgentByName(req: GetAgentByNameRequest, headers?: Record<string, string> ): Promise<GetAgentByNameResponse> {
let defaultHeaders = {
"Content-Type": "application/json",
};
if (headers) {
defaultHeaders = { ...defaultHeaders, ...headers };
}
const response = await fetch( "https://localhost//agents/getAgentByName", {
method: 'POST',
headers: defaultHeaders,
body: JSON.stringify(req)
});
const result: GetAgentByNameResponse = await response.json();
return result;
}
openapi: 3.0.3
info:
title: SecretService
description: This is a generated API Spec
version: This is a generated API Spec
servers:
- url: http://localhost:4010
- url: http://localhost:8080
paths:
/agents/getAgentByName:
post:
operationId: getAgentByName
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GetAgentByNameRequest"
responses:
default:
content:
application/json:
schema:
$ref: "#/components/schemas/GetAgentByNameResponse"
description: default response
components:
schemas:
GetAgentByNameRequest:
type: object
required:
- name
properties:
name:
type: string
GetAgentByNameResponse:
type: object
required:
- error
- agent
properties:
error:
nullable: true
$ref: "#/components/schemas/Grenade"
agent:
$ref: "#/components/schemas/Agent"
Agent:
type: object
required:
- name
- age
- department
properties:
name:
type: string
age:
type: integer
department:
type: string
Grenade:
type: object
required:
- code
- msg
- name
properties:
code:
type: integer
msg:
type: string
name:
type: string
{
"openapi": "3.0.3",
"info": {
"title": "SecretService",
"description": "This is a generated API Spec",
"version": "This is a generated API Spec"
},
"servers": [
{
"url": "http://localhost:4010"
},
{
"url": "http://localhost:8080"
}
],
"paths": {
"/agents/getAgentByName": {
"post": {
"operationId": "getAgentByName",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAgentByNameRequest"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAgentByNameResponse"
}
}
},
"description": "default response"
}
}
}
}
},
"components": {
"schemas": {
"GetAgentByNameRequest": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
},
"GetAgentByNameResponse": {
"type": "object",
"required": [
"error",
"agent"
],
"properties": {
"error": {
"nullable": true,
"$ref": "#/components/schemas/Grenade"
},
"agent": {
"$ref": "#/components/schemas/Agent"
}
}
},
"Agent": {
"type": "object",
"required": [
"name",
"age",
"department"
],
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "integer"
},
"department": {
"type": "string"
}
}
},
"Grenade": {
"type": "object",
"required": [
"code",
"msg",
"name"
],
"properties": {
"code": {
"type": "integer"
},
"msg": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}