Thispackagehasowbeerewritte,substatiallyimprovedadreleasedasthelaravel-jso-api/laravelpackage.Documetatiofortheewversioisavailableoourewwebsitelaraveljsoapi.ioadthecodeisowdevelopedudertheLaravelJSON:APIGithuborgaisatio.
Thecloudcreativity/laravel-jso-apipackageisowcosideredtobethelegacypackage.Aswekowitisiuseialotofproductioapplicatios,itwillcotiuetoreceivebugfixesadupdatesforewLaravelversios.However,itisologersupportedforewfeatures.
Ifyouarestartigaewproject,pleaseusetheewpackagelaravel-jso-api/laravelistead.
ItroductioBuildfeature-richadstadards-compliatAPIsiLaravel.
ThispackageprovidesallthecapabilitiesyoueedtoaddJSONAPIcompliatAPIstoyourapplicatio.Extesivesupportforthespecificatio,icludig:
FetchigresourcesFetchigrelatioshipsIclusioofrelatedresources(compouddocumets)Sparsefieldsets.Sortig.Pagiatio.FilterigCreatigresources.Updatigresources.Updatigrelatioships.Deletigresources.Validatioof:JSONAPIdocumets;adQueryparameters.Thefollowigadditioalfeaturesarealsosupported:
FullsupportforEloquetresources,withfeaturessuchas:Automaticeagerloadigwheicludigrelatedresources.Easyrelatioshiped-poits.Soft-deletigadrestorigEloquetresources.Pageadcursorbasedpagiatio.Asychroousprocessig.Supportmultiplemedia-typeswithiyourAPI.GeeratorsforalltheclassesyoueedtoaddaresourcetoyourAPI.WhatisJSONAPI?Fromjsoapi.org
Ifyou'veeverarguedwithyourteamaboutthewayyourJSONresposesshouldbeformatted,JSONAPIisyourati-bikesheddigweapo.
Byfollowigsharedcovetios,youcaicreaseproductivity,takeadvatageofgeeralizedtoolig,adfocusowhatmatters:yourapplicatio.ClietsbuiltaroudJSONAPIareabletotakeadvatageofitsfeaturesaroudefficietlycachigresposes,sometimeselimiatigetworkrequestsetirely.
Forfulliformatioothespec,plusexamples,seehttps://jsoapi.org.
TutorialadDocumetatioWatatutorialtogetstarted?ReadtheHowtoJSON:APILaraveltutorial.
FullpackagedocumetatioisavailableoReadtheDocs.
SlackJoitheLaravelJSON:APIcommuityoSlack.
LaravelVersiosLaravelThisPackage^8.0^3.0^7.0^2.0^6.0^1.75.8.*^1.75.7.*^1.05.6.*^1.05.5.*^1.0MakesureyoucosulttheUpgradeGuidewheupgradigbetweemajororpre-releaseversios.
LiceseApacheLicese(Versio2.0).PleaseseeLiceseFileformoreiformatio.
IstallatioIstallatioisviacomposer.Seethedocumetatioforcompleteistructios.
CotributigCotributiosareabsolutelywelcome.Ideallysubmitapullrequest,evemoreideallywithuittests.Pleaseotethefollowig:
BugFixes-submitapullrequestagaistthemasterbrach.Ehacemets/NewFeatures-submitapullrequestagaistthedevelopbrach.Werecommedsubmittigaissuebeforetakigthetimetoputtogetherapullrequest.
评论