Original README snapshot from the linked source repository. Visit the repository for the latest content.
Metadata Fetch
A dart library for extracting metadata in web pages. Supports OpenGraph, Meta, Twitter Cards, and Structured Data (Json-LD)
Available on Pub Dev:
Pub
Metadata Structure
Metadata:
- title
- description
- image
- url
Usage
Extract Metadata for a given URL
import 'package:metadata_fetch/metadata_fetch.dart';
main() async {
final myURL = 'https://flutter.dev';
var data = await MetadataFetch.extract(myURL);
print(data.title)
print(data.description)
print(data.image)
print(data.url)
var dataAsMap = data.toMap();
}
Parsing Manually
Get aggregated Metadata from a document
This method prioritizes Open Graph data, followed by Twitter Card, JSON-LD and finally falls back to HTML metadata.
import 'package:metadata_fetch/metadata_fetch.dart';
import 'package:http/http.dart' as http;
void main () async {
final myURL = 'https://flutter.dev';
var response = await http.get(myURL);
var document = MetadataFetch.responseToDocument(response);
var data = MetadataParser.parse(document);
print(data);
}
Manually specify which Metadata parser to use
import 'package:metadata_fetch/metadata_fetch.dart';
import 'package:http/http.dart' as http;
void main () async {
final myURL = 'https://flutter.dev';
var response = await http.get(myURL);
var document = responseToDocument(response);
var ogData = MetadataParser.OpenGraph(document);
print(ogData);
var htmlData = MetadataParser.HtmlMeta(document);
print(htmlData);
var structuredData = MetadataParser.JsonLdSchema(document);
print(structuredData);
var twitterCardData = MetadataParser.TwitterCard(document);
print(twitterCardData);
}
Provide a fallback url when manually parsing
If the parsers cannot extract a URL from the document, you may optionally provide a URL in MetadataFetch.parse().
This URL will be added in the final Metadata structure, and is used to resolve images with relative URLs (non-absolute URLs).
import 'package:metadata_fetch/metadata_fetch.dart';
import 'package:http/http.dart' as http;
void main () async {
final myURL = 'https://flutter.dev';
var response = await http.get(myURL);
var document = MetadataFetch.responseToDocument(response);
var data = MetadataParser.parse(document, url:myURL);
print(data);
}
Credit
This library is inspired by open_graph_parser.
However this one tries to be more general.
Roadmap
- Weighted or Preferred Metadata. Can assign custom weights for each parser to provide a fallback priority sytem
- Improve Documentation
Questions, Bugs, and Feature Requests
Please forward all queries about this project to the issue tracker.