twitter-openapi-typescript icon indicating copy to clipboard operation
twitter-openapi-typescript copied to clipboard

Implementation of Twitter internal API (Twitter graphql API) in TypeScript

twitter-openapi-typescript

issues / discussions

Table of Contents

This repository contains two packages.

  • twitter-openapi-typescript Package for human-friendly TypeScript
  • twitter-openapi-typescript-generated TypeScript package automatically generated from twitter-openapi by OpenAPI generator
graph LR
  A[twitter-openapi]--Auto Generated-->B[twitter-openapi-typescript-generated]
  B--Simplified handling-->C[twitter-openapi-typescript]

twitter-openapi-typescript

Learn more about people-friendly TypeScript packages here.

twitter-openapi-typescript/README.md

twitter-openapi-typescript-generated

Note! twitter-openapi-typescript-generated is a package for advanced users who are familiar with Twitter's API. In general, twitter-openapi-typescript should be used!

Build

git clone https://github.com/fa0311/twitter-openapi-typescript.git
cd twitter-openapi-typescript-generated
openapi-generator-cli version # 6.5.0
java -jar tools/openapi-generator-cli.jar generate -g typescript-fetch -c tools/openapi-generator-config.yaml
npm run build

Setup

npm i twitter-openapi-typescript-generated

License

This project is dual licensed. You can choose one of the following licenses:

  • Custom License
  • GNU Affero General Public License v3.0

Usage

twitter-openapi-typescript-generated/README.md