firstapi

An application built with aqueduct.

Running the Application in Development

Run aqueduct serve from this directory to run the application.

If you wish to use the debugger in your IDE, run the bin/main.dart script from your IDE.

Running Application Tests

To run all tests for this application, run the following in this directory:

pub run test

You may also run tests from an IntelliJ IDE by right-clicking on a test file or test case and selected 'Run tests'.

Tests will be run using the configuration file config.src.yaml. This file should contain test configuration values and remain in source control. This file is the template for config.yaml files, which live on deployed server instances.

See the application test harness, test/app/harness.dart, for more details. This file contains a TestApplication class that can be set up and torn down for tests.

For more information, see Getting Started and Testing.

Application Structure

Routes and other initialization are configured in lib/firstapi_sink.dart. Endpoint controller files are in lib/controller/.

Configuration

The file config.src.yaml is used for testing: it should be checked into source control and contain values for testing purposes. It should maintain the same keys as config.yaml.

Creating API Documentation

In the project directory, run:

aqueduct document

This will print a JSON OpenAPI specification to stdout.

Deploying an Application

See the documentation for Deployment.