sayenpl/xml-analysis-api repository overview

⁠XML analysis API

⁠API server that analyses the content of xml files

This application is an example of using StAX and SAX API to parse XML content

To run a new docker container use the command line like this:

$ docker run -p 8080:8080 -t sayenpl/xml-analysis-api

The application is then available on http://localhost:8080/analyze

HTTP request example

curl -i -X POST \
   -H "Content-Type:application/json" \
   -d \
'{ \
   "url": "https://sayen.pl/xml-analysis-api/3dprinting-posts.xml" \
}' \
 'http://localhost:8080/analyze/'

Find other files on archive site https://archive.org/details/stackexchange⁠

Response example

{
    "analyseDate": "2017-08-10T18:21:32.445",
    "details": {
        "firstPost": "2016-01-12T18:45:19.963",
        "lastPost": "2016-03-04T13:30:22.41",
        "totalPosts": 545,
        "questions": 185,
        "answers": 360,
        "totalAcceptedPosts": 102,
        "avgScore": 3,
        "minScore": -5,
        "maxScore": 18
    }
}

⁠SAX vs. StAX

Both SAX and StAX are stream/event oriented XML parsers, but there is a subtle difference in how they work. SAX uses a "push" model, StAX uses a "pull" model. With a SAX push model you have not control over how and when the parser iterates over the file. Once you start the parser, it iterates all the way until the end, calling your handler for each and every XML event in the input XML document. The StAX pull model means that it is your "handler" class that calls the parser, not the other way around. Thus your handler class controls when the parser is to move on to the next event in the input. In other words, your handler "pulls" the XML events out of the parser. Additionally, you can stop the parsing at any point.

The StAX parser is available by default on: http://localhost:8080/analyze and on: http://localhost:8080/analyze/StAX The SAX parser is available on: http://localhost:8080/analyze/SAX

This application lets you to compare both parsers in action.

Where to file issues: https://github.com/mariuszszymanskipl/xml-analysis-api⁠