README

此Laravel包为法国政府的GEO API提供了一个包装器。

安装

您可以通过composer安装此包

composer require yannickyayo/laravel-api-geo

使用

use Yannickyayo\LaravelApiGeo\Facades\LaravelApiGeo;

//---------- Recherches ----------//

// Chercher une commune
$response = LaravelApiGeo::towns()->search('nom', 'Pau');
/*
Clés possible pour la recherche des communes :
[
    'codePostal',
    'codeDepartement',
    'codeRegion',
    'nom',
    'lon',
    'lat',
]
*/

// Chercher un département
$response = LaravelApiGeo::departments()->search('nom', 'Pyrénées-Atlantiques');
/*
Clés possible pour la recherche des départements :
[
    'code',
    'codeRegion',
    'nom',
]
*/

// Chercher une région
$response = LaravelApiGeo::regions()->search('nom', 'Nouvelle-Aquitaine');
/*
Clés possible pour la recherche des régions :
[
    'code',
    'nom',
]
*/

/*
Exemple de résultat :
    [
        "status_code" => 200,
        "data" => "[{"code":"64445","codeDepartement":"64","codeRegion":"75","nom":"Pau","codesPostaux":["64000","64023"],"surface":3149.75,"population":77251,"centre":{"type":"Point","coordinates":[-0.3462,43.3197]},"contour":{"type":"Polygon","coordinates":[[...]]},"_score":0.24253612514094966,"departement":{"code":"64","nom":"Pyrénées-Atlantiques"},"region":{"code":"75","nom":"Nouvelle-Aquitaine"}}]",
    ]

    Vous recevez un tableau contenant de code status de la réponse et les données au format json.
*/

仅获取某些列

您可以使用fields()方法限制API返回的列

$response = LaravelApiGeo::towns()->fields(['nom', 'surface'])->search('nom', 'Pau');

/*
Colonnes possibles pour les communes :
[
    'code',
    'codeDepartement',
    'codeRegion',
    'nom',
    'codesPostaux',
    'surface',
    'population',
    'centre',
    'contour',
    'departement',
    'region',
]

Colonnes possibles pour les départements
[
    'nom',
    'code',
    'codeRegion',
    'region',
]

Colonnes possibles pour les régions
[
    'code',
    'nom',
]
*/

测试

composer test

变更日志

有关最近更改的更多信息，请参阅变更日志。

贡献

有关详细信息，请参阅贡献指南。

安全漏洞

有关报告安全漏洞的详细信息，请参阅我们的安全策略。

鸣谢

• LEONE Yannick
• 所有贡献者

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证。