Utilizing FME as an API Test Framework

Utilizing FME as an API Test
Framework

Presenter
The
Peak
of
Data
Integration
20
23
Peter
Veenstra
Director of Data Architecture
Pivvot/Terracon 32 years in geospatial industry - analyst, programmer,
architect, consultant, director
Location Intelligence, Software as a Service
Company (4 years, 27 people, remote)
Geotechnical, Environmental, Facilities,
Materials Engineering Company (50+ years,
5000+ people, 175 oﬃces/remote)

The
Peak
of
Data
Integration
20
23
Agenda
1. What data? Why an API? Why FME?
2. Testing
3. Pivvot Public API/Postman
4. Test Harness using FME Form Workbenches
5. Conclusions
Image Source: www.pixabay, https://www.pipingengineer.org/pipeline-earth-work/

The
Peak
of
Data
Integration
20
23
More than just testing an
end-point, FME offers a simple,
fast, and repeatable test of
geospatial API by visualizing
data

The
Peak
of
Data
Integration
20
23
Why data? Why an API? Why FME?
Data are accessible through the Pivvot Platform
• 1. Data informs decision making
• 2a. Organizations want bespoke access to good
and reliable data
• 2b. An API supports client specific work-flows
• 3. FME is purpose-built for
diagramming/proto-typing work-flows,
visualization, and repeatability
8 years in
the
making
123
Spatial
Data
Layers
½ Billion+
records in
PostGIS
AWS
180 Data
Agencies
4000+
Data
Sources
FME Flow
Ingest,
Curate,
QA/QC
Row
Level
Metadata
30 Day /
90 Day
Refresh
Cycle

The
Peak
of
Data
Integration
20
23

The
Peak
of
Data
Integration
20
23
Testing
Each test does something to a
ﬁxture and uses assertions to
compare the actual result against
the expected result.
The outcome of each test can be:
• Pass: the test subject works as
expected.
• Fail: something is wrong with
the test subject.
• Error: something is wrong in
the test itself, which means we
don’t know if the thing we’re
testing is working properly or
not.

The
Peak
of
Data
Integration
20
23
Testing an API is easy, testing an API with
geospatial data visually isn’t so easy
Challenges
● Postman is great but is one-oﬀ
● Pivvot data is geospatial
Solution
● FME Form allows emulation of workﬂows which
demonstrate the API in action AND show the
results - in a map

The
Peak
of
Data
Integration
20
23
API Listing
User Data
● GET Get Dataset Features
● POST Filter Dataset Features
● POST Create Dataset Features
● GET Get Dataset Feature by Id
● PUT Update Dataset Feature by ID
● PUT Update Dataset Features (multiple)
● DEL Delete features by id
● DEL Delete Features (multiple)
WMS
● GET GetCapabilities
● GET GetMAP
Pivvotdata (110+ layers)
● GET datasets
● POST search
● POST Feature Search
Reporting
● POST report list
● GET report link
● POST create geometry report
Route XP
● POST report list
● GET report link
● POST create geometry report
1 Client = 1 Account
Authentication - x-api-key
Quota/Rate

The
Peak
of
Data
Integration
20
23 Get CapabilitiesGet Datasets

The
Peak
of
Data
Integration
20
23 ExtractClip Geometries

The
Peak
of
Data
Integration
20
23 Test WMS - Build Leaﬂet → VS Code → LiveServer

The
Peak
of
Data
Integration
20
23
FME is great for testing APIs
FME is great for visualizing the
data in the API test

The
Peak
of
Data
Integration
20
23
FME for API Testing
● Super rich geospatial data
● Well deﬁned API
● HttpCaller → JSON →
Features → Map
● Visual and Process Testing
Image Source: www.istock.com

FME in Action: Top 5 Transformers
1. HttpCaller
2. JSONExtractor, JSONFragmentor
3. GeometryExtractor
4. HTML Reporter
5. Creator

The
Peak
of
Data
Integration
20
23
Resources
● www.safe.com
● www.postman.com
● www.leaﬂet.js
● www.aws.com
● www.pivvot.com
● HTTPCaller
● JSONExtractor
● JSONFragmenter
● GeometryExtractor
● HTMLReporter
● Creator

ThankYou!
pveenstra@pivvot.com
X @PCGVeenstra
LinkedIn

Utilizing FME as an API Test Framework

More Related Content

Similar to Utilizing FME as an API Test Framework (20)

More from Safe Software (20)

Recently uploaded (20)

Utilizing FME as an API Test Framework