ivalentin
/
SWDB


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513
							<?php
    /**
     * API Help view.
     *
     * Shows API documentation.
     *
     * @category View
     * @var mixed[] $API API help structure.
     */
?>
<?php
    include __DIR__ . "/api.php";
?>
<!DOCTYPE html>
<html lang='en'>
    <head>
        <meta content='text/html; charset=utf-8' http-equiv='content-type'/>
        <meta name='viewport' content='width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1'/>
        <title>SWDB APIv2</title>
        <link rel='shortcut icon' href='<?=URL::IMG["LOGO"]?>sw.png'/>
        <!-- CSS -->
        <link rel='stylesheet' type='text/css' href='<?=URL::CSS?>ui.css'/>
        <style>

            section#navbar{
                text-align: left;
                position: fixed;
                top: 0;
                left: 0;
                width: 15%;
                height: 100%;
                border-radius: 0;
                margin: 0 1em 0 0;
                padding: 0em 0.4em 0.1em 0.4em;
                border-left: 0;
                border-top: 0;
                border-bottom: 0;
            }

            section#navbar hr{
                height: 0em;
                padding: 0;
                margin: 0 1em;
                border: 0.01em solid #3105;
                border-radius: 1em;
            }

            section#navbar h1{
                text-align: center;
                margin-top: 0;
            }

            section#navbar h1 img{
                max-width: 100%;
                display: block;
                margin: auto auto -1em auto;
            }

            section#navbar h1 div{
                text-shadow: 0 0 0.5em #000000, 0 0 0.5em #000000, 0 0 0.2em #000000, 0 0 0.2em #000000;
                font-family: monospace, monospace;
            }

            section#navbar h1 div#swdb{
                font-weight: bold;
                font-size: 160%;
                margin-bottom: -0.2em;
            }

            section#navbar h1 div#api{
                font-style: italic;
                font-size: 110%;
            }

            section#navbar h3 {
                margin: 0.4em 0 0.2em 1em;
                border-left: 0.5em solid #3105;
                border-radius: 0.2em;
                padding-left: 0.3em;
                background-color: #00000000;
                transition: all .3s ease-in-out;
            }

            section#navbar h3:hover{
                background-color: #3105;
            }

            section#navbar h3 a{
                color: #cccccc
            }

            section#navbar h3:hover a{
                color: #ffffff
            }

            section#navbar ul {
                margin: 0.2em 0;
                list-style: none;
            }

            section#navbar ul li{
                border-left: 0.5em solid #3105;
                border-radius: 0.2em;
                padding-left: 0.3em;
                margin-bottom: 0.2em;
                background-color: #00000000;
                transition: all .3s ease-in-out;
            }

            section#navbar ul li:hover{
                background-color: #3105;
            }

            section#navbar ul li a{
                color: #cccccc
            }

            section#navbar ul li:hover a{
                color: #ffffff
            }

            section#navbar div#copyright{
                text-align: center;
                font-size: 70%;
                position: absolute;
                bottom: 1em;
            }

            section.category{
                margin: 2em 1em 1em 18%;
            }

            section.category h2{
                padding: 0.5em 3em;
            }

            section.category article{
                margin: 1.5em;
                padding-left: 1em;
                padding-right: 1em;
                text-align: left;
            }

            section.category article h3{
                vertical-align: bottom;
            }

            section.category article h3 span.description{
                font-style: italic;
                font-size: 90%;
            }

            section.category article:not(:last-child){
                padding-bottom: 1em;
                margin-bottom: 1em;
                border-bottom: 0.1em solid #ffffff66;
            }

            section.category article div.command span{
                display: inline-block;
                border-radius: 0.6em;
                padding: 0.3em 0.5em;
                border-width: 0.15em;
                border-style: solid;
                color: #ffffff;
                font-family: monospace, monospace;
                font-weight: bold;
            }

            section.category article div.command span.url{
                background-color: #292b36;
                border-color: #4b4d57;
            }

            section.category article div.command span.type{
                text-transform: uppercase;
            }

            section.category article div.command span.type_GET {
                background-color: #008000;
                border-color: #22a222;
            }

            section.category article div.command span.type_PUT {
                background-color: #e5c500;
                border-color: #f7e722;
            }

            section.category article div.command span.type_POST {
                background-color: #4070ec;
                border-color: #6292fe;
            }

            section.category article div.command span.type_DELETE {
                background-color: #ed0039;
                border-color: #ff225b;
            }

            section.category article table{
                border-collapse: collapse;
                width: 80%;
                border-radius: 0.5em;
                margin: 0.5em auto 1em auto;
            }

            section.category article table th {
                background-color: #331100;
                text-align: left;
                font-weight: bold;
                padding: 0.5em 1em;
                border: 0.1px solid #e0e0e0;
            }

            section.category article table td {
                background-color: #352413;
                vertical-align: top;
                padding: 0.2em 0.4em;
                border: #e0e0e0 1px solid;
            }

            section.category article table td.name {
                font-family: monospace, monospace;
                font-weight: bold;
            }

            section.category article table td.type {
                font-family: monospace, monospace;
                font-weight: bold;
            }

            section.category article table td.status {
                font-family: monospace, monospace;
                font-weight: bold;
            }

            section.category article table td.description span.optional {
                font-size: 90%;
                color: #bbbbbb;
                font-style: italic;
            }

            section#example{
                position: fixed;
                display: none;
                top: 15%;
                left: 20%;
                width: 60%;
                max-width: 90em;
                height: 70%;
                max-height: 30em;
                text-align: right;
            }

            section#example article{
                text-align: right;
            }

            section#example article pre#example_content{
                text-align: left;
                background-color: #292b36;
                border: 0.3em solid #4b4d57;
                border-radius: 0.8em;
                padding: 1em;
                max-height: 20em;
                overflow: scroll;
            }

        </style>
        <!-- Javascript -->
        <script>
            function showExample(command, status, example){
                document.getElementById('example_title').innerHTML = command + " HTTP status " + status + " response example";
                document.getElementById('example_content').innerHTML = JSON.stringify(JSON.parse(example), null, 4);
                document.getElementById('example').style.display = 'block';
            }
            function closeExample(command, status, example){
                document.getElementById('example').style.display = 'none';
            }
        </script>
        <!-- Meta tags -->
        <link rel='canonical' href='<?=URL::BASE?>API/v2/help/'/>
        <link rel='author' href='SWDB'/>
        <link rel='publisher' href='SWDB'/>
        <meta name='description' content='SWDB API v2 Documentation'/>
        <meta property='og:title' content='SWDB APIv2'/>
        <meta property='og:url' content='<?=URL::BASE?>API/v2/help/'/>
        <meta property='og:description' content='SWDB API v2 Documentation'/>
        <meta property='og:image' content='<?=URL::IMG["LOGO"]?>sw.png'/>
        <meta property='og:site_name' content='SWDB'/>
        <meta property='og:type' content='website'/>
        <meta property='og:locale' content='en'/>
        <meta name='twitter:card' content='summary'/>
        <meta name='twitter:title' content='SWDB APIv2'/>
        <meta name='twitter:description' content='SWDB API v2 Documentation'/>
        <meta name='twitter:image' content='<?=URL::IMG["LOGO"]?>sw.png'/>
        <meta name='twitter:url' content='<?=URL::BASE?>API/v2/help/'/>
        <meta name='robots' content='index follow'/>
    </head>
    <body>
        <section id='navbar' class='content'>
            <h1>
                <div id='swdb'>
                    <img alt=' ' src='<?=URL::IMG["LOGO"]?>sw.png'/>
                    SWDB
                </div>
                <div id='api'>
                    API v2
                </div>
            </h1>
            <hr/>
<?php
            foreach ($API["category"] as $category){
?>
                <h3>
                    <a href='#category_<?=$category["name"]?>'>
                        <?=$category["name"]?>
                    </a>
                </h3>
                <ul>
<?php
                    foreach ($category["command"] as $command){
?>
                        <li>
                            <a href='#command_<?=$command["name"]?>' title='<?=$command["description"]?>'>
                                <?=$command["name"]?>
                            </a>
                        </li>
<?php
                    }
?>
                </ul>
                <hr/>
<?php
            }
?>
            <div id='copyright'>
                Version 2.1. Developed by <a href="https://inigovalentin.com">Iñigo Valentin</a>.
                <br/>
                <br/>
                Source code available on <a href="https://github.com">Github</a> under the GPLv3.
                <br/>
                <br/>
                Neither I nor this tool are affiliated with or endorsed by <a href="http://com2us.com/">Com2uS</a> in any way. The Summoners War logo and the monster images are property of their respective owners (Com2US, probably). Monsters images and info are parsed from <a href="https://swarfarm.com">https://swarfarm.com</a>.
            </div>
        </section>
<?php
        foreach ($API["category"] as $category){
?>
            <section id='category_<?=$category["name"]?>' class='category content'>
                <h2>
                    <?=$category["name"]?>
                </h2>
<?php
                foreach ($category["command"] as $command){
?>
                    <article id='command_<?=$command["name"]?>'>
                        <h3>
                            <?=$command["name"]?>
                            <span class='description'>
                                - <?=$command["description"]?>
                            </span>
                        </h3>
                        <div class='command'>
                            <span class='type type_<?=$command["type"]?>'>
                                <?=$command["type"]?>
                            </span>
                            <span class='url'>
                                <?=htmlspecialchars($command["url"])?>
                            </span>
                        </div>
                        <table class='params'>
                            <thead>
                                <tr>
                                    <th class='header' colspan='3'>
                                        Parameters
                                    </th>
                                </tr>
                                <tr>
                                    <th class='name'>
                                        Parameter
                                    </th>
                                    <th class='type'>
                                        Type
                                    </th>
                                    <th class='description'>
                                        Description
                                    </th>
                                </tr>
                            </thead>
                            <tbody>
<?php
                                foreach ($command["parameter"] as $param){
?>
                                    <tr>
                                        <td class='name'>
                                            <?=$param["key"]?>
                                        </td>
                                        <td class='type'>
                                            <?=$param["type"]?>
                                        </td>
                                        <td class='description'>
                                            <?=($param["optional"] ? "<span class='optional'>[Optional] </span>" : "")?>
                                            <?=$param["description"]?>
                                        </td>
                                    </tr>
<?php
                                }
?>
                            </tbody>
                        </table>
                        <table class='success'>
                            <thead>
                                <tr>
                                    <th class='header' colspan='2'>
                                        Sucessfull Responses
                                    </th>
                                </tr>
                                <tr>
                                    <th class='status'>
                                        Status
                                    </th>
                                    <th class='description'>
                                        Description
                                    </th>
                                </tr>
                            </thead>
                            <tbody>
<?php
                                foreach ($command["success"] as $status){
?>
                                    <tr>
                                        <td class='status'>
                                            HTTP/1.1 <?=$status["status"]?>
                                        </td>
                                        <td class='description'>
                                            <?=$status["description"]?>
<?php
                                            if ($status["example"] != null){
?>
                                                <span class='fake_a' onclick="showExample('<?=$command["name"]?>', <?=$status["status"]?>, '<?=htmlspecialchars(json_decode($status["example"]), ENT_QUOTES)?>')">
                                                    View example.
                                                </span>
<?php
                                            }
?>
                                        </td>
                                    </tr>
<?php
                                }
?>
                            </tbody>
                        </table>
                        <table class='error'>
                            <thead>
                                <tr>
                                    <th class='header' colspan='2'>
                                        Error Responses
                                    </th>
                                </tr>
                                <tr>
                                    <th class='status'>
                                        Status
                                    </th>
                                    <th class='description'>
                                        Description
                                    </th>
                                </tr>
                            </thead>
                            <tbody>
<?php
                                foreach ($command["error"] as $status){
?>
                                    <tr>
                                        <td class='status'>
                                            HTTP/1.1 <?=$status["status"]?>
                                        </td>
                                        <td class='description'>
                                            <?=$status["description"]?>
<?php
                                            if ($status["example"] != null){
?>
                                                <span class='fake_a' onclick="showExample('<?=$command["name"]?>', '<?=htmlspecialchars(json_decode($status["example"]), ENT_QUOTES)?>')">
                                                    View example.
                                                </span>
<?php
                                            }
?>
                                        </td>
                                    </tr>
<?php
                                }
?>
                            </tbody>
                        </table>
                    </article>
<?php
                }
?>
            </section>
            <section id='example' class='content'>
                <h2 id='example_title'>
                </h2>
                <article>
                    <pre id='example_content'>
                    </pre>
                    <input type='button' value='Close' onClick='closeExample();'>
                </article>
            </section>
<?php
        }
?>
    </body>
</html>