npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

graphql-from-swagger

v0.7.0

Published

<a href="http://badge.fury.io/js/graphql-from-swagger"><img src="https://badge.fury.io/js/graphql-from-swagger.svg"></a>

Downloads

32

Readme

graphql-from-swagger

🍇 Swagger 하나로 GraphQL 관련 코드를 생성해주는 CLI입니다.

demo

개요

간단한 설정 파일 하나와 명령어 하나로 Swagger를 통해 GraphQL 관련 코드를 생성해주는 CLI입니다.

Input

  • Swagger

Output

  • GraphQL Schema
  • Schema Type Definition
  • RESTDataSource(apollo-datasource-rest) Child Class
  • GraphQL Resolvers

CLI Usage

$ npx graphql-from-swagger

혹은

$ npm i -g graphql-from-swagger
$ graphql-from-swagger

Config

프로젝트 루트 디렉토리에 graphql-from-swagger.config.json 파일을 생성합니다.

다음은 예시 설정 파일입니다.

{
  "swaggerPaths": ["test/swagger.json", "https://petstore.swagger.io/v2/swagger.json"],
  "schemaOutputFiles": ["generated/heroes.graphql", "generated/petstore.graphql"],
  "typesOutputFiles": ["generated/HeroesTypes.ts", "generated/PetstoreTypes.ts"],
  "restDataSourceOutputFiles": ["generated/HeroesApi.ts", "generated/PetstoreApi.ts"],
  "resolversOutputFiles": ["generated/HeroesResolvers.ts", "generated/PetstoreResolvers.ts"]
}

설정을 위한 5가지 변수가 있습니다.

| field | type | description | ext | |---------------------------|----------|----------------------------------------------------------------|---------------------| | swaggerPaths | string[] | swagger.json 혹은 swagger.yaml 파일의 경로 혹은 url입니다. | .json | .yaml | url | | schemaOutputFiles | string[] | swagger를 통해 생성될 GraphQL Schema 파일의 경로입니다. | .graphql | | typesOutputFiles | string[] | GraphQL Schema를 통해 생성될 Type Definition 파일의 경로입니다. | .ts | | restDataSourceOutputFiles | string[] | RESTDataSource(apollo-datasource-rest)의 자식클래스 파일의 경로입니다. | .ts | | resolversOutputFiles | string[] | 생성될 resolvers 파일의 경로입니다. | .ts |

Dependencies

  • swagger를 통해 GraphQL Schema를 생성할 때 swagger-to-graphql 라이브러리를 사용합니다.
  • GraphQL Schema를 통해 Typescript Type Definition 파일을 생성할 때 @graphql-codegen/typescript 라이브러리를 사용합니다.

License

MIT