http_status

Constants enumerating the HTTP status codes in Dart. All status codes defined in RFC1945 (HTTP/1.0, RFC2616 (HTTP/1.1), and RFC2518 (WebDAV) are supported.

Installation

dart pub add http_status
# or
flutter pub add http_status

Or in the dependencies: section of your pubspec.yaml, add the following line:

dependencies:
  http_status: <latest_version>

Usage

A simple usage example:

import 'package:http_status/http_status.dart';

main() {
  print('${HttpStatusCode.ok}');
  // 200

  print('${HttpStatus.ok}');
  // HttpStatus(
  //   code: 200,
  //   name: 'OK',
  //   description: 'The request was fulfilled.'
  // )

  print('${HttpStatusCode.noContent}');
  // 204

  print('${HttpStatus.fromCode(404)}');
  // HttpStatus(
  //   code: 404,
  //   name: 'Not Found',
  //   description: 'The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.'
  // )

  // isInformation (Http Status Code 200 - 299)
  print(HttpStatusCode.processing.isInformationHttpStatusCode); // true
  print(HttpStatusCode.notFound.isInformationHttpStatusCode); // false
  print(HttpStatus.fromCode(103).isInformationHttpStatusCode); // true
  print(HttpStatus.fromCode(404).isInformationHttpStatusCode); // false
  print(103.isInformationHttpStatusCode); // true
  print(400.isInformationHttpStatusCode); // false

  // isSuccessful (Http Status Code 200 - 299)
  print(HttpStatusCode.accepted.isSuccessfulHttpStatusCode); // true
  print(HttpStatusCode.notFound.isSuccessfulHttpStatusCode); // false
  print(HttpStatus.fromCode(200).isSuccessfulHttpStatusCode); // true
  print(HttpStatus.fromCode(404).isSuccessfulHttpStatusCode); // false
  print(200.isSuccessfulHttpStatusCode); // true
  print(400.isSuccessfulHttpStatusCode); // false

  // isRedirect (Http Status Code 300 - 399)
  print(HttpStatusCode.permanentRedirect.isRedirectHttpStatusCode); // true
  print(HttpStatusCode.notFound.isRedirectHttpStatusCode); // false
  print(HttpStatus.fromCode(303).isRedirectHttpStatusCode); // true
  print(HttpStatus.fromCode(404).isRedirectHttpStatusCode); // false
  print(303.isRedirectHttpStatusCode); // true
  print(400.isRedirectHttpStatusCode); // false

  // isClientError (Http Status Code 400 - 499)
  print(HttpStatusCode.notFound.isClientErrorHttpStatusCode); // true
  print(HttpStatusCode.processing.isClientErrorHttpStatusCode); // false
  print(HttpStatus.fromCode(404).isClientErrorHttpStatusCode); // true
  print(HttpStatus.fromCode(500).isClientErrorHttpStatusCode); // false
  print(404.isClientErrorHttpStatusCode); // true
  print(200.isClientErrorHttpStatusCode); // false

  // isServerError (Http Status Code 500 - 599)
  print(HttpStatusCode.internalServerError.isServerErrorHttpStatusCode); // true
  print(HttpStatusCode.notFound.isServerErrorHttpStatusCode); // false;
  print(HttpStatus.fromCode(502).isServerErrorHttpStatusCode); // true
  print(HttpStatus.fromCode(200).isServerErrorHttpStatusCode); // false
  print(503.isServerErrorHttpStatusCode); // true
  print(200.isServerErrorHttpStatusCode); // false
}

1. Classic method

   import 'package:http/http.dart' as http;
   import 'package:http_status/http_status.dart';
   
   final res = await http.get(Uri.parse(url));
   
   if (res.statusCode == HttpStatusCode.ok) { // res.statusCode == 200
     final httpStatus = HttpStatus.fromCode(res.statusCode);
   
     return {
       'statusCode': res.statusCode,
       'httpStatus': httpStatus,
       'data': res.body
     };
   }
   

2. Alternative method (Same as #1 method, but with more direct validation using .isSuccessfulHttpStatusCode)

   import 'package:http/http.dart' as http;
   import 'package:http_status/http_status.dart';
   
   final res = await http.get(Uri.parse(url));
   
   if (res.statusCode.isSuccessfulHttpStatusCode) {
     final httpStatus = HttpStatus.fromCode(res.statusCode);
   
     return {
       'statusCode': res.statusCode,
       'httpStatus': httpStatus,
       'data': res.body
     };
   }
   

3. Alternative method (Same as #1 method, if you need the HttpStatus object from the dynamically generated status code of the response)

   import 'package:http/http.dart' as http;
   import 'package:http_status/http_status.dart';
   
   final res = await http.get(Uri.parse(url));
   
   final httpStatusResponse = HttpStatus.fromCode(res.statusCode);
   
   if (httpStatusResponse.isSuccessfulHttpStatusCode) {
     return {
       'statusCode': res.statusCode,
       'httpStatus': httpStatusResponse,
       'data': res.body
     };
   } else if (httpStatusResponse.isClientErrorHttpStatusCode) {
      // Handle client error
      // ...
   } else {
      // Handle other code error
      // ...
   }
   

Thanking all Awesome Contributors :heart:

Contributions of any kind are welcome!

License

BSD

Features and bugs

Please file feature requests and bugs at the issue tracker.