shelf_serve 0.2.7

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 44

shelf_serve

Configure and run a http server.

Defining a http server

You define a http server by creating a shelf_serve.yaml file. This file lists the middleware and handlers that should be used to handle requests. For example:


handlers:
  /html:
    type: compound
    handlers:
      /web:
        type: pub
        package:
          path: test_web
      /static:
        type: static
        path: test_static
  /source:
    type: proxy
    url: https://github.com/appsup-dart/shelf_serve
  /api:
    type: rpc
  /echo:
    type: echo

middlewares:
  log_requests:

dependencies:
  test_api:
    path: test_api
  test_echo:
    path: test_echo
    

Adding middleware

In the middlewares section of the shelf_serve.yaml file, you can list the middlewares to be used and define optional configuration parameters.

There are two build in middlewares:

  • log_requests logs requests to stdout.
  • cors adds cors headers to the response.

Example:


middlewares:
  cors:
    allow: 
      headers: "rpc-auth, content-type"
      methods: "POST, GET, PUT, OPTIONS, DELETE"
      origin: "*"

Adding handlers

In the handlers section of the shelf_serve.yaml file, you can list different handlers to be used for different routes.

There are five build in handlers:

  • static serves the static files in the directory defined by the path parameter.
  • pub runs pub serve on a dart package and forwards requests to it.
  • proxy proxies requests to the server defined in the url parameter.
  • rpc serves a rest api defined by the rpc package.
  • compound a compound handler that can contain other handlers and middlewares.

Note: when using the rpc handler, you should add the package that defines the api classes in the dependencies section.

Defining custom handlers and middleware

You can define custom handlers and middleware by annotating a factory function that creates the handler or middleware based on some configuration parameters.

For example

import 'package:shelf_serve/shelf_serve.dart';
import 'package:shelf/shelf.dart';

@ShelfHandler("echo")
createEchoHandler(String type, String route,
                      Map<String,dynamic> config) {
  return (Request r) async => new Response.ok(await r.readAsString());
}

You should add the package that defines those custom handlers and middlewares to the dependencies section.

Running the server from command line

First install the shelf_serve executable:

pub global activate shelf_serve

Then goto the directory where the shelf_serve.yaml file is located and run:

shelf_serve serve

By default the server will listen to port 8080. You can define another port by:

shelf_serve serve --port 5000

Running the server from code

Create a dart file and import all the necessary dependencies.

Run the method serve:

serve('path/to/shelf_serve.yaml', port: 5000);

Alternatively, you can run the method serveInIsolate, which will automatically do all the necessary imports based on the dependencies section in the shelf_serve.yaml file.

Creating a docker file

First install the shelf_serve executable:

pub global activate shelf_serve

Then goto the directory where the shelf_serve.yaml file is located and run:

shelf_serve create-docker-project

By default the project will be created in build/project. To select another output directory run:

shelf_serve create-docker-project --output-directory some/other/path

Next, go to the built project directory. There will be a Dockerfile there. You can create a container image by running:

docker build -t my/app .

And to run this image:

docker run -d -p 8080:8080 my/app

Changelog

0.2.7

  • add gzip middleware

0.2.0

  • api changes
  • create docker project

0.1.0

  • api changes
  • command line utility

0.0.1

  • Initial version

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate shelf_serve

2. Use it

The package has the following executables:


$ shelf_serve

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  shelf_serve: ^0.2.7

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:shelf_serve/shelf_serve.dart';
  
Version Uploaded Documentation Archive
0.2.7 May 22, 2017 Go to the documentation of shelf_serve 0.2.7 Download shelf_serve 0.2.7 archive
0.2.6 May 22, 2017 Go to the documentation of shelf_serve 0.2.6 Download shelf_serve 0.2.6 archive
0.2.5 Apr 14, 2017 Go to the documentation of shelf_serve 0.2.5 Download shelf_serve 0.2.5 archive
0.2.4 Apr 14, 2017 Go to the documentation of shelf_serve 0.2.4 Download shelf_serve 0.2.4 archive
0.2.3 Oct 3, 2016 Go to the documentation of shelf_serve 0.2.3 Download shelf_serve 0.2.3 archive
0.2.2 Oct 3, 2016 Go to the documentation of shelf_serve 0.2.2 Download shelf_serve 0.2.2 archive
0.2.1 Sep 16, 2016 Go to the documentation of shelf_serve 0.2.1 Download shelf_serve 0.2.1 archive
0.2.0 Sep 15, 2016 Go to the documentation of shelf_serve 0.2.0 Download shelf_serve 0.2.0 archive
0.1.3 Sep 13, 2016 Go to the documentation of shelf_serve 0.1.3 Download shelf_serve 0.1.3 archive
0.1.2 Sep 13, 2016 Go to the documentation of shelf_serve 0.1.2 Download shelf_serve 0.1.2 archive

All 13 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
6
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
58
Overall:
Weighted score of the above. [more]
44
Learn more about scoring.

We analyzed this package on Aug 16, 2018, and provided a score, details, and suggestions below. Analysis was completed with status tool failures using:

  • Dart: 2.0.0
  • pana: 0.11.8

Platforms

Detected platforms: unsure

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Issues and suggestions

Fix dependencies in pubspec.yaml.

Running pub upgrade failed with the following output:

ERR: The current Dart SDK version is 2.0.0.
 
 Because shelf_serve depends on unscripted >=0.0.2 which requires SDK version <2.0.0, version solving failed.

Fix platform conflicts.

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Add SDK constraint in pubspec.yaml.

For information about setting SDK constraint, please see https://www.dartlang.org/tools/pub/pubspec#sdk-constraints.

Package is getting outdated.

The package was released 64 weeks ago.

Package is pre-v1 release.

While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction of the API.

Maintain an example.

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use shelf_serve.dart.

Format lib/shelf_serve.dart.

Run dartfmt to format lib/shelf_serve.dart.

Format lib/src/annotations.dart.

Run dartfmt to format lib/src/annotations.dart.

Fix additional 4 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/src/config.dart (Run dartfmt to format lib/src/config.dart.)
  • lib/src/handlers.dart (Run dartfmt to format lib/src/handlers.dart.)
  • lib/src/middlewares.dart (Run dartfmt to format lib/src/middlewares.dart.)
  • lib/src/server_script.dart (Run dartfmt to format lib/src/server_script.dart.)