MODX प्रोजेक्ट के लिए Symfony 5 + API प्लेटफ़ॉर्म पर एक RESTful API कैसे बनाएं

इस पाठ से आप सीखेंगे कि किसी भी CMS पर किसी भी साइट के लिए जल्दी से RESTful API कैसे बनाया जाए, MODX सिर्फ एक उदाहरण है।

एपीआई बनाने के लिए, मैं उपयोग करूंगा:

• https://symfony.com/
• https://api-platform.com/

परिणाम यहाँ है:
https://github.com/andchir/modx2-api

मैंने लिनक्स पर वर्णित सब कुछ किया था, लेकिन मुझे लगता है कि विंडोज पर कमांड में अंतर बड़ा नहीं होगा। मैंने संगीतकार और सिम्फनी उपयोगिता को पूर्व-स्थापित किया।

एक परियोजना और उपयोगकर्ता कक्षाएं बनाना

मैं एक परियोजना बनाता हूं:

composer create-project symfony/skeleton modx2-api 

एपीआई बनाने के लिए आवश्यक पैकेज स्थापित करें:

 cd modx2-api composer req api composer req migrations composer req form composer req maker --dev 

मैं स्थानीय सर्वर शुरू करता हूं।
यदि सिम्फनी उपयोगिता स्थापित है:

 symfony server:start 

या तो:

 php -S 127.0.0.1:8000 -t public 

मैं यह सत्यापित करने के लिए ब्राउज़र में पता खोलता हूं कि सब कुछ काम करता है:
http://127.0.0.1:8000/

मैं .env फ़ाइल को खोलता हूं और MODX पर प्रोजेक्ट डेटाबेस में कनेक्शन स्ट्रिंग संपादित करता हूं :

 DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/db_name 

अब आपको एक उपयोगकर्ता बनाने और लॉगिन और पासवर्ड द्वारा प्राधिकरण प्रणाली को कॉन्फ़िगर करने की आवश्यकता है।

अतिरिक्त पैकेज स्थापित करें:

 composer req jwt-auth composer req orm-fixtures --dev composer req profiler --dev 

नया .jvt- प्रमाणीकरण-बंडल पैकेज विकल्प .env फ़ाइल में दिखाई देते हैं।

मैं उपयोगकर्ता की इकाई और रिपॉजिटरी कक्षाएं (डॉक्ट्रिन ओआरएम) बनाता हूं:

 php bin/console make:user 

दो फाइलें दिखाई दीं:

 src/Entity/User.php src/Repository/UserRepository.php 

मैं डेटाबेस में "उपयोगकर्ता" तालिका बनाता हूं:

 bin/console doctrine:schema:create 

मैं निर्देशों के अनुसार उपयोगकर्ता प्राधिकरण को कॉन्फ़िगर करता हूं:

• https://symfony.com/doc/current/security/form_login_setup.html
• https://api-platform.com/docs/core/jwt/#configuring-the-symfony-securitybundle

 <?php namespace App\Controller; use App\Entity\User; use App\Form\Type\LoginType; use App\Form\Type\UpdateProfileType; use Doctrine\ORM\EntityManagerInterface; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Routing\Annotation\Route; use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface; use Symfony\Component\Security\Http\Authentication\AuthenticationUtils; use Symfony\Component\Validator\Validator\ValidatorInterface; class SecurityController extends AbstractController { /** * @Route("/login", name="app_login") * @param AuthenticationUtils $authenticationUtils * @return Response */ public function loginAction(AuthenticationUtils $authenticationUtils): Response { if ($this->getUser()) { return $this->redirectToRoute('api_entrypoint'); } $form = $this->createForm(LoginType::class); $error = $authenticationUtils->getLastAuthenticationError(); $lastUsername = $authenticationUtils->getLastUsername(); return $this->render('security/login.html.twig', [ 'form' => $form->createView(), 'last_username' => $lastUsername, 'error' => $error ]); } } 

मैं उपयोगकर्ताओं को बनाने के लिए एक वर्ग उत्पन्न करता हूं:

 php bin/console make:fixtures 

अधिक विवरण यहां: https://symfony.com/doc/current/security.html#a-create-your-user-class

 <?php namespace App\DataFixtures; use App\Entity\User; use Doctrine\Bundle\FixturesBundle\Fixture; use Doctrine\Common\Persistence\ObjectManager; use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface; class UserFixtures extends Fixture { private $passwordEncoder; public function __construct(UserPasswordEncoderInterface $passwordEncoder) { $this->passwordEncoder = $passwordEncoder; } public function load(ObjectManager $manager) { $user = new User(); $user ->setEmail('admin@admin.com') ->setRoles(['ROLE_USER', 'ROLE_ADMIN']); $user->setPassword($this->passwordEncoder->encodePassword( $user, 'admin'//  )); $manager->persist($user); $manager->flush(); } } 

मैं ईमेल पता "admin@admin.com" और पासवर्ड "व्यवस्थापक" के साथ एक व्यवस्थापक बनाता हूं:

 php bin/console doctrine:fixtures:load --append --group=UserFixtures 

बाद में इस डेटा को बदला जा सकता है।

मैं config / jwt / फ़ोल्डर में कुंजियाँ उत्पन्न करता हूँ:

 jwt_passhrase=$(grep ''^JWT_PASSPHRASE='' .env | cut -f 2 -d ''='') echo "$jwt_passhrase" | openssl genpkey -out config/jwt/private.pem -pass stdin -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096 echo "$jwt_passhrase" | openssl pkey -in config/jwt/private.pem -passin stdin -out config/jwt/public.pem -pubout setfacl -R -mu:www-data:rX -mu:"$(whoami)":rwX config/jwt setfacl -dR -mu:www-data:rX -mu:"$(whoami)":rwX config/jwt 

टोकन के निर्माण की जाँच:

 curl -X POST -H "Content-Type: application/json" http://localhost:8000/authentication_token -d '{"email":"admin@admin.com","password":"admin"}' 

मैं एक प्रवास बनाता हूं:

 php bin/console make:migration 

अब मजा हिस्सा है।

एपीआई और प्रलेखन पीढ़ी

मैं सभी डेटाबेस तालिकाओं के लिए इकाई वर्ग उत्पन्न करता हूं:

 php bin/console doctrine:mapping:import "App\Entity" annotation --path=src/Entity 

मैं कक्षाओं के लिए गेटर्स और सेटर जनरेट करता हूं:

 php bin/console make:entity --regenerate App 

मैं एक वर्ग का कोड खोलता हूं, उदाहरण के लिए src / Entity / ModxSiteContent.php । @ApiResource एनोटेशन जोड़ें:

ModxSiteContent के लिए एपीआई तैयार है।

मैं http: // localhost: 8000 / api पेज खोलता हूं

मैं टोकन लेता हूं, "अधिकृत करें" बटन पर क्लिक करें, टोकन के साथ लाइन डालें:

 Bearer MY_TOKEN 

मैं "इसे आज़माएं" बटन पर क्लिक करता हूं और फिर "निष्पादित करें" बटन। मुझे यह परिणाम मिलता है:

टेबल संबंध

मैं यह वर्णन नहीं करूंगा कि फ़िल्टर कैसे बनाए जाते हैं ताकि डॉक्यूमेंटेशन डुप्लिकेट न हो, लेकिन मैं एक उदाहरण दूंगा कि आप तालिकाओं के लिए संबंध कैसे बना सकते हैं, क्योंकि यह थोड़ा पेचीदा है।

MODX के मामले में, उपयोगकर्ता डेटा को एक अलग तालिका "user_attributes" में संग्रहीत किया जाता है। उदाहरण के लिए, मुझे GET अनुरोध द्वारा उपयोगकर्ताओं के नमूने में उनके ईमेल, नाम, फोन नंबर आदि को जोड़ने की आवश्यकता है। मैं क्लास कोड App \ Entity \ ModxUsers को खोलता हूं , निजी संपत्ति $attributes को जोड़ता हूं और एनोटेशन "@ORM \ OneToOne" में वर्ग App \ Entity \ ModxUserAttributes के साथ कनेक्शन का वर्णन करता हूं:

 /** * @var ModxUserAttributes * * @ORM\OneToOne(targetEntity="ModxUserAttributes", mappedBy="user") * @Groups({"read", "attributes"}) */ private $attributes; 

फिर से मैं लापता गेटर्स जोड़ता हूं और बसता हूं:

 php bin/console make:entity --regenerate App\\Entity\\ModxUsers 

कृपया ध्यान दें कि मैंने @ApiResource एनोटेशन में "विशेषताएँ" समूह जोड़ा है

मैं कक्षा का कोड खोलता हूं App \ Entity \ ModxUserAttributes , annotation @ApiResource और वर्ग App\Entity\ModxUsers साथ कनेक्शन App\Entity\ModxUsers :

 /** * @var ModxUsers * * @ORM\OneToOne(targetEntity="ModxUsers", mappedBy="attributes") * @ORM\JoinColumn(name="internalKey", referencedColumnName="id") */ private $user; 

उन सभी गुणों के लिए जिन्हें चयन में जोड़ने की आवश्यकता है, मैं एनोटेशन @Groups({"attributes"}) सम्मिलित करता हूं।

परिणाम:

नतीजतन, आपके आवेदन में प्राधिकरण के लिए, आपको पहले URL "/ प्रमाणीकरण_टोकन" के लिए एक लॉगिन (ईमेल) और पासवर्ड भेजना होगा, एक टोकन प्राप्त करना होगा और फिर "प्राधिकरण" शीर्षक में प्रत्येक अनुरोध में यह टोकन भेजना होगा:

यदि परियोजना https://github.com/andchir/modx2-api उपयोगकर्ताओं के लिए दिलचस्प है, तो यह विकसित होगी। मैं उन सभी लोगों से पीआर की प्रतीक्षा कर रहा हूं जो मदद करना चाहते हैं।