Generators

This page details all the generators you can specify in your generators.yml.

All of our generators are open source.

​

fern-typescript-sdk

Source code

The TypeScript SDK generator outputs a fully functionality TypeScript/JavaScript SDK. It can publish the SDK to npmjs.org (or any other npm repository).

- name: fernapi/fern-typescript-sdk
  version: 0.0.255
  output:
    location: npm
    package-name: "@fern-api/plantstore"
    token: ${NPM_TOKEN}
  github:
    repository: fern-api/plantstore-node

​

fern-python-sdk

Source code

The Python SDK generator outputs a fully functionality Python SDK. It can publish the SDK to pypi.org (or any other pypi repository).

- name: fernapi/fern-python-sdk
  version: 0.1.0
  output:
    location: pypi
    package-name: fern-plantstore
    token: ${PYPI_TOKEN}
  github:
    repository: fern-api/plantstore-python

​

fern-java-sdk

Source code

The Java SDK generator outputs a fully functionality Java SDK. It can publish the SDK to Maven Central (or any other Maven repository).

- name: fernapi/fern-java-sdk
  version: 0.0.132
  output:
    location: maven
    coordinate: io.github.fern-api:plantstore
    username: ${MAVEN_USERNAME}
    password: ${MAVEN_PASSWORD}
  github:
    repository: fern-api/plantstore-java

​

fern-postman

Source code

The Postman generator outputs a Postman Collection (in Postman’s collection.json format). The generator can sync the collection with your Postman Workspace.

- name: fernapi/fern-postman
  version: 0.0.32
  output:
    location: postman
    api-key: ${POSTMAN_API_KEY}
    workspace-id: ${POSTMAN_WORKSPACE_ID}
  github:
    repository: fern-api/plantstore-postman

To find your workspace ID, select the ⓘ icon in the top right of the workspace view.

​

fern-fastapi-server

Source code

The FastAPI generator outputs lots of helpful code for implementing your FastAPI backend:

• Abstract classes that register your endpoints with FastAPI and handle all the networking logic.
• Pydantic models for all the types in your API.
• Exceptions that extend HTTPException that you can throw from wherever. These exceptions handle serialization and setting the HTTP status code.

- name: fernapi/fern-fastapi-server
  version: 0.0.33
  output:
    location: local-file-system
    path: ../../src/venus/generated/server

​

fern-pydantic-model

Source code

The Pydantic Model generator outputs Pydantic Models for all the types in your API. This saves you time and ensures your backend types align with your SDKs.

- name: fernapi/fern-pydantic-model
  version: 0.0.33
  output:
    location: local-file-system
    path: ../../src/venus/generated/server

​

fern-openapi

Source code

The OpenAPI generator outputs an OpenAPI 3.1 document for your API. You can feed it into any OpenAPI-compatible tools, like documentation providers.

- name: fernapi/fern-openapi
  version: 0.0.14
  github:
    repository: fern-api/plantstore-openapi