A Flutter package for logging API requests (Http Requests & GraphQL) requests.
Http request
, GraphQL
and WebSockets
.cURL
to re-run it again (ex. Postman
).And more and more
RequestsInspector
widget on your screen:π±π : Shake your phone.
π±π : Long-Press on any free space on the screen.
Also you can share the request details as (Log or cURL command) with your team to help them debug the API requests.
From Inspector to Postman 𧑠ποΈ
Now you can extract cURL
command from the inspector to send the request again from your terminal or Postman πͺπͺ
Setup
First, add it at the top of your MaterialApp
with enabled: true
.
void main() {
runApp(const RequestsInspector(
child: MyApp(),
));
}
Dio
, pass by RequestsInspectorInterceptor()
to Dio.interceptors
and we are good to go ποΈποΈ.final dio = Dio()..interceptors.add(RequestsInspectorInterceptor());
Dio
then don't worryIn your API request just add a new RequestDetails
using RequestInspectorController
filled with the API data.
InspectorController().addNewRequest(
RequestDetails(
requestName: requestName,
requestMethod: RequestMethod.GET,
url: apiUrl,
queryParameters: params,
statusCode: responseStatusCode,
responseBody: responseData,
),
);
a. Normal InspectorController().addNewRequest
.
Future<List<Post>> fetchPosts() async {
final dio = Dio();
final params = {'userId': 1};
final response = await dio.get(
'https://jsonplaceholder.typicode.com/posts',
queryParameters: params,
);
final postsMap = response.data as List;
final posts = postsMap.map((postMap) => Post.fromMap(postMap)).toList();
InspectorController().addNewRequest(
RequestDetails(
requestName: 'Posts',
requestMethod: RequestMethod.GET,
url: 'https://jsonplaceholder.typicode.com/posts',
queryParameters: params,
statusCode: response.statusCode ?? 0,
responseBody: response.data,
),
);
return posts;
}
b. Using RequestsInspectorInterceptor
.
Future<List<Post>> fetchPosts() async {
final dio = Dio()..interceptors.add(RequestsInspectorInterceptor());
final response = await dio.get('https://jsonplaceholder.typicode.com/posts');
final postsMap = response.data as List;
final posts = postsMap.map((postMap) => Post.fromMap(postMap)).toList();
return posts;
}
Shake
your phone to get the Inspector
To use requests_inspector
with graphql_flutter library.
you jus need to wrap your normal HttpLink
with our GraphQLInspectorLink
and we are done.
Example:
Future<List<Post>> fetchPostsGraphQlUsingGraphQLFlutterInterceptor() async {
Future<List<Post>> fetchPostsGraphQlUsingGraphQLFlutterInterceptor() async {
final client = GraphQLClient(
cache: GraphQLCache(),
link: Link.split(
(request) => request.isSubscription,
GraphQLInspectorLink(WebSocketLink('ws://graphqlzero.almansi.me/api')),
GraphQLInspectorLink(HttpLink('https://graphqlzero.almansi.me/api')),
),
);
const query = r'''query {
post(id: 1) {
id
title
body
}
}''';
final options = QueryOptions(document: gql(query));
final result = await client.query(options);
if (result.hasException) {
log(result.exception.toString());
} else {
log(result.data.toString());
}
var post = Post.fromMap(result.data?['post']);
return [post];
}
requests_inspector
(Stopper) enables your to stop and edit requests (before sending it to server) and responses (before receiving it inside the app).
MaterialApp
then pass it to RequestsInspector
to show Stopper dialogs.final navigatorKey = GlobalKey<NavigatorState>();
void main() => runApp(
RequestsInspector(
// Add your `navigatorKey` to enable `Stopper` feature
navigatorKey: navigatorKey,
child: const MyApp(),
),
);
...
@override
Widget build(BuildContext context) {
return MaterialApp(
navigatorKey: navigatorKey, // <== Here!
...
Obviously, The shaking won't be good enough for those platforms π
So you can specify showInspectorOn
with ShowInspectorOn.LongPress
.
void main() {
runApp(const RequestsInspector(
enabled: true,
showInspectorOn: ShowInspectorOn.LongPress
child: MyApp(),
));
}
OR, you can just pass ShowInspectorOn.Both
to open the Inspector
with Shaking
or with LongPress
.
void main() {
runApp(const RequestsInspector(
enabled: true,
showInspectorOn: ShowInspectorOn.Both
child: MyApp(),
));
}
GraphQL
.GraphQL
request and response displaying structure.This project is licensed under the MIT License - see the LICENSE file for details.