ern create-api <name>

Description

  • Create a new API project based on a Swagger schema

Syntax

ern create-api <name>

Options

--scope/-s <scope>

  • Specify a given npm scope for the API project package

--version/-v <version>

  • Specify an initial version for the API
  • Default If this option is not used, the API defaults to 0.0.1.

--author/-a <author>

  • Specify the author of the API in the package.json file of the API
  • Default If this option is not used, the author is not set.

--schemaPath/-p <schemaPath>

  • Generate the API using a pre-existing Swagger schema located at the given schemaPath
  • Default If this option is not used the command uses a default starter schema to generate the initial API. You can modify this option at a later time and then regenerate the API using the ern regen-api command.

Remarks

  • The generated API project contains the API client-code for the three platforms (JavaScript, Android, and iOS) as well as any models and code to guide the implementation of the API.
  • The generated API project is meant to be published to npm and it contains the package.json file.

  • Once you have a version of your API ready, you should publish it to npm to make it available for people to use. Considering that the API is published to npm, you should make sure before generating the API, that the name is not already used by another API otherwise you won't be able to publish an API with a duplicate name.

  • API projects are created with the react-native prefix added to the name in the format: react-native-{{{name}}}-api.

  • The API project is created in a new directory named after the complete API project name.

ern regen-api | Add a new request, event, or model to an existing API project schema and regenerate the API
ern create-api-impl | Create an implementation skeleton project for a specified API

Examples

ern create-api weather
This example shows how to create an API project named react-native-weather-api located in the new directory named react-native-weather-api.

ern create-api weather --scope MyCompany
This example shows how to create a scoped package named @MyCompany/react-native-weather-api.

results matching ""

    No results matching ""