shelf_exception_handler 0.2.0
#Shelf Exception Handler
Shelf middleware for easily creating shelf.Responses by simply throwing an HttpException.
This package is a fork of shelf_exception_response.
##What problem does it solve When creating web service you have to handle a lot of http responses simply informing the client about a server-side error. Not all of those situations occur withing your request handlers but rather in some service classes or elsewhere in your application. In your controller you would write something like:
// given a simple function that throws in certain conditions
String doJob() {
if(!myCondition) {
throw new MyError();
}
return "Successfully done Job";
}
// code in the request handler
try {
String res = doJob();
return new shelf.Response.ok(res);
} on MyError {
return new shelf.Response.forbidden("You have to be logged in");
}
When using HttpExceptions and the exception response middleware your controller could be simplified to the following:
// given a simple function that throws HttpException in certain conditions
String doJob() {
if(!myCondition) {
throw new ForbiddenException();
}
return "Successfully done Job";
}
// code in request handler
String res = doJob();
return new shelf.Response.ok(res);
The thrown HttpException will be handled and an appropriate shelf.Response will be generated. The response will have a correct Http status (eg.: 403), and the response body will be encoded in an acceptable format (Json, Xml, Text) using Tentacle Response Formatter.
##Example
import 'package:shelf/shelf.dart' as shelf;
import 'package:shelf/shelf_io.dart' as io;
import 'package:shelf_exception_handler/shelf_exception_handler.dart';
import 'package:http_exception/http_exception.dart';
// a simple shelf server with exception response enabled.
void main() {
var handler = const shelf.Pipeline()
// add exception response middleware to the pipeline
.addMiddleware(exceptionHandler())
.addHandler((shelf.Request request){
// handler can now throw HttpException that is handled a formatted.
throw new NotFoundException({"something":["additional", 4, true]},
"This will show in the message");
});
io.serve(handler, 'localhost', 8080).then((server) {
print('Serving at http://${server.address.host}:${server.port}');
});
}
##Adding additional response data for the body
Every HttpException can take a data parameter that accepts a
Map<String, dynamic> data
in the constructor that provides you with the
ability to add custom data to the generated response. The fields status and
message are always added to the response data but can be overridden by data.
The message field can now receive additional text which will be appended to the
HTTP Status Name (e.g.: Not Acceptable: Your text here) via the Exceptions
details param.
Please keep in mind that responses of type "text/plain" do currently not output any data other than status and message (how should I format them anyhow ?). To add support for your own output format or change an existing one look at Shelf Response Formatter under the section "Add your own response formatter".
// adding custom data and error details to response
throw new NotAcceptableException({
"validation_errors": {
"username": "to_long",
"password": "not_contains_special_characters"
},
"Validation failed"
});
##Add your own exception types There are already predefined exceptions for the most common Http error code available but you may find that there is a specific error code missing. In that case you can simply define your own HttpException type by extending or implementing HttpException.
// creating custom exception
class IamATeapotException extends HttpException {
final int status = 418;
final String message = "I'm a teapot";
final Map<String, dynamic> data;
const IamATeapotException([this.data]);
}
##License Apache 2.0
0.2.0 #
- upgrade to Dart 2.0
- upgrade to Shelf 0.7
0.1.0 #
- fork from shelf_exception_response
- rename the package and main identifiers to not collide with the shelf_exception_response package.
- move exceptions to the http_exception package and use them from there
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies:
shelf_exception_handler: ^0.2.0
2. Install it
You can install packages from the command line:
with pub:
$ pub get
with Flutter:
$ flutter pub get
Alternatively, your editor might support pub get
or flutter 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_exception_handler/shelf_exception_handler.dart';
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
37
|
Health:
Code health derived from static analysis.
[more]
|
100
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
87
|
Overall:
Weighted score of the above.
[more]
|
66
|
We analyzed this package on Dec 10, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.6.1
- pana: 0.12.21
Maintenance suggestions
Package is getting outdated. (-13.42 points)
The package was last published 59 weeks ago.
Maintain an example.
None of the files in the package's example/
directory matches known example patterns.
Common filename patterns include main.dart
, example.dart
, and shelf_exception_handler.dart
. Packages with multiple examples should provide example/README.md
.
For more information see the pub package layout conventions.
Dependencies
Package | Constraint | Resolved | Available |
---|---|---|---|
Direct dependencies | |||
Dart SDK | >=2.0.0 <3.0.0 | ||
http_exception | ^0.2.1 | 0.2.1 | |
shelf | ^0.7.0 | 0.7.5 | |
shelf_response_formatter | ^0.2.0 | 0.2.0 | |
Transitive dependencies | |||
async | 2.4.0 | ||
charcode | 1.1.2 | ||
collection | 1.14.12 | ||
convert | 2.1.1 | ||
http_parser | 3.1.3 | ||
meta | 1.1.8 | ||
path | 1.6.4 | ||
petitparser | 2.4.0 | ||
source_span | 1.5.5 | ||
stack_trace | 1.9.3 | ||
stream_channel | 2.0.0 | ||
string_scanner | 1.0.5 | ||
term_glyph | 1.1.0 | ||
typed_data | 1.1.6 | ||
xml | 3.6.1 | ||
Dev dependencies | |||
grinder | ^0.8.0 | ||
test | ^1.3.0 |