PHPackages uspdev/webservice - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. uspdev/webservice ActiveLibrary[API Development](/categories/api) uspdev/webservice ================= Biblioteca para criação de webservices rest 1.0.6(6y ago)0511GPL-3.0-or-laterPHP Since Mar 27Pushed 6y ago9 watchersCompare [ Source](https://github.com/uspdev/webservice)[ Packagist](https://packagist.org/packages/uspdev/webservice)[ RSS](/packages/uspdev-webservice/feed)WikiDiscussions master Synced 1w ago READMEChangelog (7)Dependencies (4)Versions (8)Used By (0) Webservice ========== [](#webservice) Biblioteca que permite criar um webservice básico com controle de usuário e controle por IPs. Não foi pensado para grandes quantidades de usuários pois o gerenciamento é simplificado. A biblioteca contém as estruturas básicas para começar um webservice, incluindo as rotas, interface de administração. Dependências ------------ [](#dependências) - PHP 7.0 ou superior - uspdev/cache - uspdev/ip-control Para o cache funcionar você precisa ter instalado o memcached. Instalação e configuração ------------------------- [](#instalação-e-configuração) Instale via composer ``` composer require uspdev/webservice ``` Configure a pasta onde ficará o arquivo de banco de dados. Sim, ele usa sqlite. ``` putenv('USPDEV_WEBSERVICE_LOCAL=' . __DIR__ . '/../local'); ``` Como o objetivo é criar webservices para serem consumidas por outros sistemas ele não se comporta bem com pessoas e navegadores. Se for o caso, pode torná-lo mais amigável com a variável abaixo. Com isso, ele irá solicitar credenciais sempre que as fornecidas não forem aceitas. O padrão é desabilitado. ``` putenv('USPDEV_WEBSERVICE_USER_FRIENDLY=1'); ``` Em ambiente de testes você pode não querer usar cache. Para isso desative o cache. Ele está ativado por padrão. ``` putenv('USPDEV_CACHE_DISABLE=1'); ``` Em geral uma api é limitada a um escopo local então faz sentido querer limitar por endereços IP. Em tese podem ser usados ipv6 mas foi testado com ipv4. para limitar a endereços específicos use a variável abaixo. Para saber como configurar o arquivo contendo os ips liberados consulte ``` putenv('USPDEV_IP_CONTROL=whitelist'); ``` Controle de acesso ------------------ [](#controle-de-acesso) O controle de acesso é por meio de usuario/senha usando http basic. Por isso é importante usar um HTTPS. Os usuários podem ser: - admin, que tem acesso à tudo, inclusive a interface de admin, se estiver ativada - usuario, que possui uma lista de rotas autorizadas para acesso. Se o usuário estiver autorizado para \*, poderá ter acesso a todas as rotas do sistema, menos a interface de admin. Alguns exemplos de como gerenciar os usuários. Por enquanto não há uma interface mais amigável para isso. ``` use Uspdev\Webservice\Auth; Auth::salvarUsuario(['username'=>'admin', 'pwd'=>'admin', 'admin'=>'1', 'allow'=>'']); Auth::salvarUsuario(['username'=>'gerente', 'pwd'=>'gerente', 'admin'=>'0', 'allow'=>'*']); Auth::salvarUsuario(['username'=>'user1', 'pwd'=>'user', 'admin'=>'', 'allow'=>'minhaclasse1']); Auth::salvarUsuario(['username'=>'user1', 'allow'=>'minhaclasse1, minhaclasse2']); // alterando o usuário user1 Auth::removerUsuario(['username'=>'gerente']); Auth::listarUsuarios(); ``` Skeleton -------- [](#skeleton) Na pasta skeleton/ tem uma estrutura de pastas que pode ser usada como exemplo. Se quiser copie o seu conteúdo para a raiz do seu projeto. A pasta public/ contém um index.php e um .htaccess para utilizar com o apache. A pasta local/ é onde ficarão os arquivos gerados pelo webservice e deve estar no .gitignore da aplicação. Por enquanto é apenas o arquivo de senhas de acesso mas pode ser colocado o arquivo com os ips liberados. A pasta src/ é onde você colocará suas classes. Se você criar uma classe \\Minha\\ClasseDeDados para prover os dados ao webservice, você deve configurar a variável $controllers da seguinte forma: ``` $controllers['classededados'] = '\Minha\ClasseDeDados'; ``` Com isso os métodos públicos dessa classe ficarão disponíveis para consumo mais ou menos assim: ``` http://servidor/dir_base/classededados// ``` Os métodos devem ser estáticos e devem retornar um array ou uma string que serão formatados como json. Você pode solicitar os seguintes formatos de saída: - ?f=json - json formatado para humanos lerem - ?f=csv - csv adequado para excel Se não for passado parâmetro o json de saída será sem formatação adequado para outros sistemas ou para parsers de json. Veja que $controllers é um array então você pode definir quantas fontes de dados quiser. Testes ------ [](#testes) Você pode rodar uns testes via shell em teste/teste.sh Ele irá subir um servidor embutido do PHP e fará algumas consultas. ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity9 Limited adoption so far Community11 Small or concentrated contributor base Maturity61 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~4 days Total 7 Last Release 2217d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/8a59480189a3ba1aa8355cb434880695569433f5d1c9e375e8238d5ff1a56beb?d=identicon)[uspdev](/maintainers/uspdev) --- Top Contributors [![masakik](https://avatars.githubusercontent.com/u/986915?v=4)](https://github.com/masakik "masakik (44 commits)") ### Embed Badge ![Health badge](/badges/uspdev-webservice/health.svg) ``` [![Health](https://phpackages.com/badges/uspdev-webservice/health.svg)](https://phpackages.com/packages/uspdev-webservice) ``` ### Alternatives [twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php)[google/common-protos Google API Common Protos for PHP 173103.7M50](/packages/google-common-protos)[hubspot/api-client Hubspot API client 23414.2M16](/packages/hubspot-api-client) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)