મુખ્ય સામગ્રીને બાયપાસ કરો

કોડિંગ સિદ્ધાંતો

ભૂલ સંદેશાઓ​

એક સારો ભૂલ સંદેશ વપરાશકર્તાને નીચેના પગલાં લેવાની જાણ કરે છે. પ્લેગ્રાઉન્ડ પબ્લિક API દ્વારા ફેંકાયેલી ભૂલોમાં કોઈપણ અસ્પષ્ટતા વિકાસકર્તાઓને સમસ્યાઓ ખોલવા માટે પ્રોત્સાહિત કરશે.

ઉદાહરણ તરીકે, નેટવર્ક ભૂલનો વિચાર કરો - શું આપણે ભૂલના પ્રકારનું અનુમાન કરી શકીએ છીએ અને આગળના પગલાંનો સારાંશ આપતો સંબંધિત સંદેશ પ્રદર્શિત કરી શકીએ છીએ?

  • નેટવર્ક ભૂલ: "તમારું ઇન્ટરનેટ કનેક્શન તૂટી ગયું છે. પેજ ફરીથી લોડ કરવાનો પ્રયાસ કરો.
  • 404: "ફાઇલ મળી શકી નથી".
  • 403: "સર્વરે ફાઇલની ઍક્સેસ અવરોધિત કરી છે".
  • CORS: સ્પષ્ટ કરો કે તે બ્રાઉઝર સુરક્ષા સુવિધા છે અને વિગતવાર સમજૂતી (MDN અથવા અન્ય વિશ્વસનીય સ્ત્રોત પર) ની લિંક ઉમેરો. વપરાશકર્તાને તેમની ફાઇલ બીજે ક્યાંક ખસેડવાનું સૂચન કરો, જેમ કે raw.githubusercontent.com, અને તેમના સર્વર પર CORS હેડર કેવી રીતે સેટ કરવા તે સમજાવતા સંસાધનની લિંક આપો.

અમે કોડ ફોર્મેટિંગ અને લિન્ટિંગ આપમેળે હેન્ડલ કરીએ છીએ. આરામ કરો, ટાઇપ કરો અને મશીનોને કામ કરવા દો.

સાર્વજનિક API​

પ્લેગ્રાઉન્ડનો ઉદ્દેશ્ય શક્ય તેટલો સાંકડો API સ્કોપ રાખવાનો છે.

પબ્લિક API ઉમેરવા સરળ છે અને દૂર કરવા મુશ્કેલ છે. નવું API રજૂ કરવા માટે ફક્ત એક PR ની જરૂર પડે છે, પરંતુ તેને દૂર કરવા માટે હજાર લાગી શકે છે, ખાસ કરીને જો અન્ય પ્રોજેક્ટ્સ પહેલાથી જ તેનો ઉપયોગ કરી ચૂક્યા હોય.

  • બિનજરૂરી કાર્યો, વર્ગો, સ્થિરાંકો, અથવા અન્ય ઘટકોનો ખુલાસો કરશો નહીં.

બ્લુપ્રિન્ટ્સ​

બ્લુપ્રિન્ટ્સ એ પ્લેગ્રાઉન્ડ સાથે ક્રિયાપ્રતિક્રિયા કરવાનો પ્રાથમિક રસ્તો છે. આ JSON ફાઇલો પ્લેગ્રાઉન્ડ ક્રમમાં ચલાવતા પગલાંઓના સમૂહનું વર્ણન કરે છે.

માર્ગદર્શિકા​

બ્લુપ્રિન્ટ પગલાં સંક્ષિપ્ત અને કેન્દ્રિત હોવા જોઈએ. તેમણે એક કામ કરવું જોઈએ અને તે સારી રીતે કરવું જોઈએ.

  • જો તમારે નવું પગલું બનાવવાની જરૂર હોય, તો પહેલા અસ્તિત્વમાં રહેલા પગલાને રિફેક્ટર કરવાનો પ્રયાસ કરો.
  • જો તે પૂરતું નથી, તો ખાતરી કરો કે નવું પગલું નવી ક્ષમતા પ્રદાન કરે છે. હાલના પગલાંની કાર્યક્ષમતાની નકલ કરશો નહીં.
  • ધારો કે પગલું એક કરતા વધુ વાર બોલાવવામાં આવશે.
  • ધારો કે તે ચોક્કસ ક્રમમાં ચાલશે.
  • તે ચકાસવા માટે યુનિટ ટેસ્ટ ઉમેરો.

બ્લુપ્રિન્ટ્સ સાહજિક અને સીધી હોવી જોઈએ.

  • એવી દલીલોની જરૂર નથી જે વૈકલ્પિક હોઈ શકે.
  • સાદા દલીલનો ઉપયોગ કરો. ઉદાહરણ તરીકે, path ને બદલે slug.
  • વર્ચ્યુઅલ JSON ફાઇલોમાં સ્થિરાંકો વ્યાખ્યાયિત કરો - PHP ફાઇલોમાં ફેરફાર કરશો નહીં.
  • બ્લુપ્રિન્ટ માટે ટાઇપસ્ક્રિપ્ટ પ્રકાર વ્યાખ્યાયિત કરો. આ રીતે પ્લેગ્રાઉન્ડ તેની JSON સ્કીમા જનરેટ કરે છે.
  • બ્લુપ્રિન્ટ સ્ટેપને હેન્ડલ કરવા માટે એક ફંક્શન લખો. તમે વ્યાખ્યાયિત કરેલા પ્રકારનો દલીલ સ્વીકારો.
  • doc સ્ટ્રિંગમાં ઉપયોગનું ઉદાહરણ આપો. તે docs માં આપમેળે પ્રતિબિંબિત થાય છે.