http_status Dart Package: A Comprehensive Guide Link to heading

Description Link to heading

• Constants: http_status provides convenient static constants representing all HTTP status codes defined in RFC 1945 (HTTP/1.0), RFC 2616 (HTTP/1.1), and RFC 2518 (WebDAV).
• Clarity: Each constant offers a clear name (e.g., ok, notFound, forbidden), making it easy to understand the meaning of a status code at a glance.
• Information: Constants also provide a concise description of the status code, which can be helpful in debugging or understanding API responses.

Http Status Codes Link to heading

A library for debugging and displaying http status codes. Includes 63 status codes, messages and desciptions sourced from the official spec https://tools.ietf.org/html/rfc723 and https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/

Key Features Link to heading

• Clean API: The interface is straightforward and intuitive, simplifying the use of status codes in your Dart applications.
• Readability: Constant names and descriptions enhance code clarity and maintainability.
• Type Safety: Static constants prevent typos and accidental use of incorrect status codes.
• Completeness: Extensive coverage of HTTP status codes ensures reliable handling of various response scenarios.

Installation Link to heading

Add the following dependency to your Dart project’s pubspec.yaml:

dependencies:
  http_status: <latest_version> # ^2.1.0 is last version compatible with v1.x

Usage Link to heading

1. Import:

   import 'package:http_status/http_status.dart';
   

2. Access Constants:

   print(HttpStatusCode.ok);          // Output: 200
   print(HttpStatus.ok.name);         // Output: OK
   print(HttpStatus.ok.code);         // Output: 200
   print(HttpStatus.ok.description);  // Output: The request was fulfilled.
   print(HttpStatus.code404NotFound); // Is an alias representing the [HttpStatus.notFound] constant, offering a direct substitute for it to facilitate auto-completion in IDEs.
   // Salida:
   // 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.',
   //  );`
   

3. Check Statuses:

   /// Returns true if this ranges between 100 y 199
   response.statusCode.isInformationHttpStatusCode;
   print(HttpStatusCode.processing.isInformationHttpStatusCode); // true
   print(HttpStatusCode.notFound.isInformationHttpStatusCode); // false
   
   /// Returns true if this ranges between 200 y 299
   response.statusCode.isSuccessfulHttpStatusCode;
   print(200.isSuccessfulHttpStatusCode); // true
   print(400.isSuccessfulHttpStatusCode); // false
   print(HttpStatusCode.accepted.isSuccessfulHttpStatusCode); // true
   print(HttpStatusCode.notFound.isSuccessfulHttpStatusCode); // false
   
   /// Returns true if this ranges between 300 y 399
   response.statusCode.isRedirectHttpStatusCode;
   print(HttpStatusCode.permanentRedirect.isRedirectHttpStatusCode); // true
   print(HttpStatusCode.notFound.isRedirectHttpStatusCode); // false
   
    /// Returns true if this ranges between 400 y 499
   response.statusCode.isClientErrorHttpStatusCode;
   print(HttpStatusCode.notFound.isClientErrorHttpStatusCode); // true
   print(HttpStatusCode.processing.isClientErrorHttpStatusCode); // false
   
   /// Returns true if this ranges between 500 y 599
   response.statusCode.isServerErrorHttpStatusCode;
   print(HttpStatusCode.internalServerError.isServerErrorHttpStatusCode); // true
   print(HttpStatusCode.notFound.isServerErrorHttpStatusCode); // false;
   
   if (response.statusCode.isSuccessfulHttpStatusCode) {
     // Handle successful response
   } else if (response.statusCode.isClientErrorHttpStatusCode) {
     // Handle client error
   } else {
     // Handle other errors
   }
   

4. Convert from Int:

   final httpStatus = HttpStatus.fromCode(response.statusCode); // response.statusCode = 404
   
   print(httpStatus);
   // Salida:
   // 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.',
   //  );
   

Example Link to heading

1. Classic method

    import 'package:http/http.dart' as http;
    import 'package:http_status/http_status.dart';
   
    final url = 'https://api.example.com/data';
   
    Future<void> fetchData() async {
      try {
        final response = await http.get(Uri.parse(url));
   
        if (response.statusCode == HttpStatusCode.ok) {
          final data = response.body;
          // Process successful response
          return {
            'statusCode': response.statusCode,
            'data': response.body
          };
        } else {
          print('Error: ${response.statusCode}');
          // Handle errors gracefully
        }
      } catch (error) {
        print('Error: $error');
      }
    }
   
    void main() {
      fetchData();
    }
   

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

    import 'package:http/http.dart' as http;
    import 'package:http_status/http_status.dart';
   
    final url = 'https://api.example.com/data';
   
    Future<void> fetchData() async {
      try {
        final response = await http.get(Uri.parse(url));
   
        if (response.statusCode.isClientErrorHttpStatusCode) { // HTTP status code 400 - 499
          // Handle client error
        } else if (response.statusCode.isSuccessfulHttpStatusCode) { // HTTP status code 200 - 299
          final data = response.body;
          // Process successful response
        } else {
          print('Error: ${response.statusCode}');
          // Handle errors gracefully
        }
      } catch (error) {
        print('Error: $error');
      }
    }
   
    void main() {
      fetchData();
    }
   

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 url = 'https://api.example.com/data';
   
    Future<void> fetchData() async {
      try {
        final response = await http.get(Uri.parse(url));
        final httpStatusResponse = HttpStatus.fromCode(response.statusCode);
   
        if (httpStatusResponse.isClientErrorHttpStatusCode) { // HTTP status code 400 - 499
          // Handle client error
        } else if (httpStatusResponse.isSuccessfulHttpStatusCode) { // HTTP status code 200 - 299
          // Process successful response
          final data = response.body;
          return {
            'statusCode': httpStatusResponse.code,
            'httpStatus': httpStatusResponse.name,
            'data': data
          };
        } else {
          print('Error: ${httpStatusResponse.code}');
          // Handle errors gracefully
        }
      } catch (error) {
        print('Error: $error');
      }
    }
   
    void main() {
      fetchData();
    }
   

This code fetches data from an API and checks the HTTP status code of the response. Based on the code, you can take appropriate actions depending on the outcome.

Additional Tips Link to heading

• Use meaningful variable names (e.g., data instead of httpStatus.description).
• Consider using try-catch blocks to handle network errors gracefully.
• Refer to the http_status documentation for the latest information and additional features.

I hope this comprehensive valuable insights into using the http_status package in your Dart projects!