Git Product home page Git Product logo

openapi-types's Introduction

OpenAPI 3.1 Types

npm version License: MIT

TypeScript types for the OpenAPI Specification.

Installation

You can install this package via npm:

npm install -D @omer-x/openapi-types

or via yarn:

yarn add -D @omer-x/openapi-types

Usage

Import the types you need in your TypeScript project:

import { OpenApiDocument } from '@omer-x/openapi-types';

// Example usage
const openApiSpec: OpenApiDocument = {
  openapi: "3.1.0",
  info: {
    title: "Sample API",
    version: "1.0.0"
  },
  paths: {}
};

You can also import specific types directly:

import type { ComponentsObject } from "@omer-x/openapi-types/components";
import type { ExampleObject } from "@omer-x/openapi-types/example";
import type { InfoObject } from "@omer-x/openapi-types/info";
import type { LinkObject } from "@omer-x/openapi-types/link";
import type { MediaTypeObject } from "@omer-x/openapi-types/media-type";
import type { OperationObject } from "@omer-x/openapi-types/operation";
import type { ParameterObject } from "@omer-x/openapi-types/parameter";
import type { PathItemObject, PathsObject } from "@omer-x/openapi-types/paths";
import type { ReferenceObject } from "@omer-x/openapi-types/reference";
import type { RequestBodyObject } from "@omer-x/openapi-types/request-body";
import type { ResponseObject, ResponsesObject } from "@omer-x/openapi-types/response";
import type { SchemaObject } from "@omer-x/openapi-types/schema";
import type { TagObject } from "@omer-x/openapi-types/tag";

License

This project is licensed under the MIT License. See the LICENSE file for details.

openapi-types's People

Contributors

omermecitoglu avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.